openapi: 3.2.0 info: description: Welcome to Cloudflare's API documentation site. license: name: BSD-3-Clause url: https://opensource.org/licenses/BSD-3-Clause title: Cloudflare Pages Deployment API version: 4.0.0 servers: - description: Client API url: https://api.cloudflare.com/client/v4 security: - api_email: [] api_key: [] - api_token: [] - user_service_key: [] tags: - name: Pages Deployment paths: /accounts/{account_id}/pages/projects/{project_name}/deployments: get: operationId: pages-deployment-get-deployments summary: List Pages deployments description: List the production or preview deployments for a Cloudflare Pages project. parameters: - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' - name: env in: query schema: description: Deployment environment to return. Valid values are `production` and `preview`. type: string example: preview enum: - production - preview - name: page in: query schema: description: Page number of results to return. type: integer example: 1 - name: per_page in: query schema: description: Number of results to return per page. type: integer example: 10 responses: '200': description: Get deployments response. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_api-response-collection' - properties: result: type: array items: $ref: '#/components/schemas/pages_deployment' required: - result type: object 4XX: description: Get deployments response failure. content: application/json: schema: $ref: '#/components/schemas/pages_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Pages Deployment x-api-token-group: - Pages Read - Pages Write x-fern-availability: generally-available x-fern-sdk-group-name: pages.deployments x-fern-sdk-method-name: list post: operationId: pages-deployment-create-deployment summary: Create a Pages deployment description: Create a Cloudflare Pages deployment from a Git branch or Direct Upload manifest. Git repositories must already be authorized in Cloudflare Pages. parameters: - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' requestBody: required: true 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: type: object properties: _headers: description: Headers configuration file for the deployment. type: string format: binary _redirects: description: Redirects configuration file for the deployment. type: string format: binary _routes.json: description: Routes configuration file defining routing rules. type: string format: binary _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. ' type: string format: binary _worker.js: description: 'Worker JavaScript file. Mutually exclusive with `_worker.bundle`. Cannot specify both `_worker.js` and `_worker.bundle` in the same request. ' type: string format: binary branch: description: Git branch to deploy. Uses the branch's `HEAD`; defaults to the project's production branch. type: string example: staging x-auditable: true commit_dirty: description: Whether the associated Git working tree has uncommitted changes. Provide `true` or `false`. type: string example: 'false' enum: - 'true' - 'false' commit_hash: description: Git commit SHA associated with the deployment. type: string example: a1b2c3d4e5f6 commit_message: description: Git commit message associated with the deployment. type: string example: Update homepage functions-filepath-routing-config.json: description: Functions routing configuration file. type: string format: binary manifest: description: 'JSON-encoded object mapping deployment file paths to their uploaded content hashes. Required for Direct Upload deployments. Maximum 20,000 entries. ' type: string example: '{"index.html": "abc123", "style.css": "def456"}' pages_build_output_dir: description: The build output directory path. type: string example: dist wrangler_config_hash: description: Hash of the Wrangler configuration file used for this deployment. type: string responses: '200': description: Create deployment response. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result: $ref: '#/components/schemas/pages_deployment' required: - result type: object 4XX: description: Create deployment response failure. content: application/json: schema: $ref: '#/components/schemas/pages_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Pages Deployment x-api-token-group: - Pages Write x-fern-availability: generally-available x-fern-sdk-group-name: pages.deployments x-fern-sdk-method-name: create /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}: delete: operationId: pages-deployment-delete-deployment summary: Delete a Pages deployment description: Remove a deployment from a Cloudflare Pages project. parameters: - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/pages_deployment_id' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' - name: force in: query schema: description: Allow deletion when a non-production deployment has an active alias. type: boolean example: true x-fern-parameter-name: allow-aliased responses: '200': description: Delete deployment response. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result: type: - object - 'null' required: - result type: object 4XX: description: Delete deployment response failure. content: application/json: schema: $ref: '#/components/schemas/pages_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Pages Deployment x-api-token-group: - Pages Write x-fern-availability: generally-available x-fern-sdk-group-name: pages.deployments x-fern-sdk-method-name: delete get: operationId: pages-deployment-get-deployment-info summary: Get a Pages deployment description: Retrieve the status and details of a Cloudflare Pages deployment. parameters: - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/pages_deployment_id' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' responses: '200': description: Get deployment info response. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result: $ref: '#/components/schemas/pages_deployment' required: - result type: object 4XX: description: Get deployment info response failure. content: application/json: schema: $ref: '#/components/schemas/pages_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Pages Deployment x-api-token-group: - Pages Read - Pages Write x-fern-availability: generally-available x-fern-sdk-group-name: pages.deployments x-fern-sdk-method-name: get /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/history/logs: get: operationId: pages-deployment-get-deployment-logs summary: Get Pages deployment logs description: Retrieve the build logs for a Cloudflare Pages deployment. parameters: - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/pages_deployment_id' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' responses: '200': description: Get deployment logs response. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result: $ref: '#/components/schemas/pages_deployment_log' required: - result type: object 4XX: description: Get deployment logs response failure. content: application/json: schema: $ref: '#/components/schemas/pages_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Pages Deployment x-api-token-group: - Pages Read - Pages Write x-fern-availability: generally-available x-fern-sdk-group-name: pages.deployments.history.logs x-fern-sdk-method-name: get /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/retry: post: operationId: pages-deployment-retry-deployment summary: Retry a Pages deployment description: Retry a previous Cloudflare Pages deployment. parameters: - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/pages_deployment_id' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' responses: '200': description: Retry deployment response. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result: $ref: '#/components/schemas/pages_deployment' required: - result type: object 4XX: description: Retry deployment response failure. content: application/json: schema: $ref: '#/components/schemas/pages_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Pages Deployment x-api-token-group: - Pages Write x-fern-availability: generally-available x-fern-sdk-group-name: pages.deployments x-fern-sdk-method-name: retry /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/rollback: post: operationId: pages-deployment-rollback-deployment summary: Roll back a Pages deployment description: Roll back production to a previous successful Cloudflare Pages deployment. parameters: - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/pages_deployment_id' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' responses: '200': description: Rollback deployment response. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result: $ref: '#/components/schemas/pages_deployment' required: - result type: object 4XX: description: Rollback deployment response failure. content: application/json: schema: $ref: '#/components/schemas/pages_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Pages Deployment x-api-token-group: - Pages Write x-fern-availability: generally-available x-fern-sdk-group-name: pages.deployments x-fern-sdk-method-name: rollback x-forge-require-confirmation: This operation rolls back the production deployment to an earlier deployment. /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/tails: post: operationId: pages-deployment-create-tail summary: Create deployment tail description: Start a tail that receives logs and exception data. parameters: - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/pages_deployment_id' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' requestBody: required: true content: application/json: schema: type: object properties: filters: description: Filters to apply to the tail session. type: array items: additionalProperties: true type: object example: filters: - outcome: - exception responses: '200': description: Create deployment tail response. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result: $ref: '#/components/schemas/pages_tail' required: - result type: object 4XX: description: Create deployment tail response failure. content: application/json: schema: $ref: '#/components/schemas/pages_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Pages Deployment x-api-token-group: - Pages Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: pages.deployments.tails x-fern-sdk-method-name: create /accounts/{account_id}/pages/projects/{project_name}/deployments/{deployment_id}/tails/{tail_id}: delete: operationId: pages-deployment-delete-tail summary: Delete deployment tail description: Deletes a tail from a Pages deployment. parameters: - name: tail_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' - name: deployment_id in: path required: true schema: $ref: '#/components/schemas/pages_deployment_id' - name: project_name in: path required: true schema: $ref: '#/components/schemas/pages_project_name' - name: account_id in: path required: true schema: $ref: '#/components/schemas/pages_identifier' responses: '200': description: Delete deployment tail response. content: application/json: schema: allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result: type: - object - 'null' required: - result type: object 4XX: description: Delete deployment tail response failure. content: application/json: schema: $ref: '#/components/schemas/pages_api-response-common-failure' security: - api_token: [] - api_email: [] api_key: [] tags: - Pages Deployment x-api-token-group: - Pages Write x-fern-availability: generally-available x-fern-ignore: true x-fern-sdk-group-name: pages.deployments.tails x-fern-sdk-method-name: delete components: schemas: pages_deployment_log: type: object properties: data: type: array items: properties: line: type: string readOnly: true ts: type: string readOnly: true required: - ts - line type: object includes_container_logs: type: boolean readOnly: true total: type: integer readOnly: true 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 required: - total - includes_container_logs - data pages_tail: description: A tail session for streaming logs from a Pages deployment. type: object properties: id: description: Identifier of the tail session. type: string example: 49a4dcf81a3940fab8453b2be3fb86ef readOnly: true url: description: Optional WebSocket URL to connect to for receiving tail events, when returned by the tail service. type: string example: wss://tail.developers.workers.dev/49a4dcf81a3940fab8453b2be3fb86ef readOnly: true required: - id pages_messages: type: array items: properties: code: type: integer minimum: 1000 documentation_url: type: string message: type: string source: type: object properties: pointer: type: string required: - code - message type: object uniqueItems: true example: [] pages_api-response-collection: type: object allOf: - $ref: '#/components/schemas/pages_api-response-common' - properties: result_info: type: object properties: count: description: Total number of results for the requested service. type: number example: 1 page: description: Current page within paginated list of results. type: number example: 1 per_page: description: Number of results per page of results. type: number example: 20 total_count: description: Total results available without any search parameters. type: number example: 2000 total_pages: description: The number of total pages in the entire result set. type: number example: 100 type: object pages_api-response-common: type: object properties: errors: $ref: '#/components/schemas/pages_messages' messages: $ref: '#/components/schemas/pages_messages' success: description: Whether the API call was successful. type: boolean example: true enum: - true required: - success - errors - messages pages_deployment: type: object properties: aliases: description: A list of alias URLs pointing to this deployment. type: - array - 'null' items: type: string x-auditable: true example: - https://branchname.projectname.pages.dev readOnly: true build_config: $ref: '#/components/schemas/pages_build_config' created_on: description: When the deployment was created. type: string format: date-time example: '2021-03-09T00:55:03.923456Z' readOnly: true x-auditable: true deployment_trigger: description: Info about what caused the deployment. type: object properties: metadata: description: Additional info about the trigger. type: object properties: branch: description: Where the trigger happened. type: string example: main x-auditable: true commit_dirty: description: Whether the deployment trigger commit was dirty. type: boolean example: false x-auditable: true commit_hash: description: Hash of the deployment trigger commit. type: string example: ad9ccd918a81025731e10e40267e11273a263421 x-auditable: true commit_message: description: Message of the deployment trigger commit. type: string example: Update index.html x-auditable: true required: - branch - commit_hash - commit_message - commit_dirty type: description: What caused the deployment. type: string example: ad_hoc enum: - github:push - ad_hoc - deploy_hook x-auditable: true readOnly: true required: - type - metadata env_vars: $ref: '#/components/schemas/pages_env_vars' environment: description: Type of deploy. type: string example: preview enum: - preview - production readOnly: true x-auditable: true id: description: Id of the deployment. type: string example: f64788e9-fccd-4d4a-a28a-cb84f88f6 readOnly: true x-auditable: true is_skipped: description: Whether the deployment was skipped. type: boolean example: true readOnly: true x-auditable: true latest_stage: $ref: '#/components/schemas/pages_stage' modified_on: description: When the deployment was last modified. type: string format: date-time example: '2021-03-09T00:58:59.045655' readOnly: true x-auditable: true project_id: description: Id of the project. type: string example: 7b162ea7-7367-4d67-bcde-1160995d5 readOnly: true x-auditable: true project_name: $ref: '#/components/schemas/pages_project_name' short_id: description: Short Id (8 character) of the deployment. type: string example: f64788e9 readOnly: true x-auditable: true skip_reason: description: Why the deployment was skipped. type: - string - 'null' example: commit_message enum: - commit_message - preview_deployments_disabled - production_deployments_disabled - path_config - branch_config - pages_to_workers_conversion - superseded_queued_build readOnly: true x-auditable: true source: $ref: '#/components/schemas/pages_source' stages: description: List of past stages. type: array items: $ref: '#/components/schemas/pages_stage' 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 readOnly: true url: description: The live URL to view this deployment. type: string example: https://f64788e9.ninjakittens.pages.dev readOnly: true x-auditable: true uses_functions: description: Whether the deployment uses functions. type: - boolean - 'null' readOnly: true 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 pages_stage: description: The status of the deployment. type: object properties: ended_on: description: When the stage ended. type: - string - 'null' format: date-time example: '2021-03-09T00:58:59.045655' readOnly: true x-auditable: true name: description: The current build stage. type: string example: deploy enum: - queued - initialize - clone_repo - build - deploy x-auditable: true started_on: description: When the stage started. type: - string - 'null' format: date-time example: '2021-03-09T00:55:03.923456Z' readOnly: true x-auditable: true status: description: State of the current stage. type: string example: success enum: - success - idle - active - failure - canceled - skipped readOnly: true x-auditable: true readOnly: true required: - name - started_on - ended_on - status pages_api-response-common-failure: type: object properties: errors: example: - code: 7003 message: No route for the URI allOf: - $ref: '#/components/schemas/pages_messages' minLength: 1 messages: example: [] allOf: - $ref: '#/components/schemas/pages_messages' result: type: - object - 'null' enum: - null success: description: Whether the API call was successful. type: boolean example: false enum: - false required: - success - errors - messages - result pages_source_config: type: object properties: deployments_enabled: 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 deprecated: true 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 example: my-org x-auditable: true owner_id: description: The owner ID of the repository. type: string example: '12345678' x-auditable: true path_excludes: description: A list of paths that should be excluded from triggering a preview deployment. Wildcard syntax (`*`) is supported. type: array items: type: string x-auditable: true path_includes: description: A list of paths that should be watched to trigger a preview deployment. Wildcard syntax (`*`) is supported. type: array items: type: string x-auditable: true 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`. type: array items: type: string x-auditable: true 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`. type: array items: type: string x-auditable: true preview_deployment_setting: description: Controls whether commits to preview branches trigger a preview deployment. type: string enum: - all - none - custom x-auditable: true production_branch: description: The production branch of the repository. type: string example: main 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 example: '12345678' x-auditable: true repo_name: description: The name of the repository. type: string example: my-repo 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 pages_env_vars: description: Environment variables used for builds and Pages Functions. type: - object - 'null' additionalProperties: discriminator: mapping: plain_text: '#/components/schemas/pages_plain_text_env_var' secret_text: '#/components/schemas/pages_secret_text_env_var' propertyName: type oneOf: - $ref: '#/components/schemas/pages_plain_text_env_var' - $ref: '#/components/schemas/pages_secret_text_env_var' type: - object - 'null' pages_build_config: description: Configs for the project build process. type: object properties: build_caching: description: Enable build caching for the project. type: - boolean - 'null' example: true x-auditable: true build_command: description: Command used to build project. type: - string - 'null' example: npm run build x-auditable: true destination_dir: description: Assets output directory of the build. type: - string - 'null' example: build x-auditable: true root_dir: description: Directory to run the command. type: - string - 'null' example: / x-auditable: true web_analytics_tag: description: The classifying tag for analytics. type: - string - 'null' example: cee1c73f6e4743d0b5e6bb1a0bcaabcc x-auditable: true web_analytics_token: description: The auth token for analytics. type: - string - 'null' example: 021e1057c18547eca7b79f2516f06o7x x-sensitive: true required: - web_analytics_tag - web_analytics_token pages_deployment_id: description: UUID of the Pages deployment, as returned by deployment list or create operations. type: string format: uuid example: f64788e9-fccd-4d4a-a28a-cb84f88f6e12 x-auditable: true pages_secret_text_env_var: description: An encrypted environment variable. type: - object - 'null' properties: type: type: string enum: - secret_text x-auditable: true value: description: Secret value. type: string x-sensitive: true example: type: secret_text value: '' required: - type - value pages_source: description: Configs for the project source control. type: object properties: config: $ref: '#/components/schemas/pages_source_config' type: $ref: '#/components/schemas/pages_source_type' required: - type - config pages_identifier: description: Identifier. type: string example: 023e105f4ecef8ad9ca31a8372d0c353 maxLength: 32 x-auditable: true pages_source_type: description: The source control management provider. type: string example: github enum: - github - gitlab x-auditable: true pages_plain_text_env_var: description: A plaintext environment variable. type: - object - 'null' properties: type: type: string enum: - plain_text x-auditable: true value: description: Environment variable value. type: string example: type: plain_text value: hello world required: - type - value pages_project_name: description: Name of the Pages project. Must begin with a lowercase letter or digit and contain only lowercase letters, digits, and hyphens. type: string example: this-is-my-project-01 pattern: ^[a-z0-9][a-z0-9-]*$ x-auditable: true 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 externalDocs: description: Cloudflare Radar Documentation url: https://developers.cloudflare.com/radar/ x-forge-commands: abuse-reports: description: Submit and track abuse reports for phishing, malware, and other policy violations on Cloudflare-proxied sites groups: appeals: description: Appeal eligibility for abuse reports emails: description: Emails sent for abuse reports mitigations: description: Mitigation actions taken in response to abuse reports accounts: description: Account settings, members, roles, subscriptions, and API tokens for your Cloudflare account groups: applications: description: Applications operations categories: description: Categories operations organizations: description: Move accounts between organizations profile: description: View and manage the profile for a Cloudflare account roles: description: View the roles available for assigning to account members, each defining a set of permissions subscriptions: description: View and manage plan subscriptions attached to this account tokens: description: Create and manage scoped API tokens for programmatic access to the Cloudflare API ai-gateway: description: Proxy, cache, rate-limit, and observe requests to AI providers — OpenAI, Anthropic, Workers AI, and more groups: custom-domains: description: Manage custom hostnames that route requests through an AI Gateway custom-providers: description: Manage account-level custom AI providers and their endpoint settings datasets: description: 'Deprecated: manage filtered collections of gateway logs used by evaluations' dynamic-routing: description: Route requests across multiple AI providers with fallback, load-balancing, and versioned deployments dynamic-routing.deployments: description: Deploy dynamic route versions and view deployment history dynamic-routing.versions: description: Create and inspect saved versions of a dynamic route evaluation-types: description: 'Deprecated: list the evaluator types that evaluations can use' evaluations: description: 'Deprecated: score the logs in a dataset with selected evaluator types' gateways: description: Create and configure AI Gateways for an account gateways.providers: description: Store and rotate upstream AI provider keys for a gateway logs: description: Inspect, annotate, and delete gateway request logs stored by Legacy Logs ai-search: description: 'Managed search-as-a-service: crawl, index, and query content with AI-powered relevance and chat completions' groups: items: description: Content indexed by AI Search instances jobs: description: Indexing job lifecycle for AI Search instances namespace: description: Logical groupings for organizing AI Search instances tokens: description: Credentials used by AI Search instances ai-security: description: Detect prompt injection, PII, and unsafe topics in traffic to your AI applications groups: custom-topics: description: Organization-specific topic categories used by AI Security for Apps content detection analytics: description: Zone-level traffic analytics — dashboard summaries, per-colo breakdowns, and Argo latency metrics groups: colo: description: Per-data-center (colo) traffic analytics breakdown for the zone dashboard: description: Aggregated zone dashboard analytics — requests, bandwidth, threats, and page views latency: description: Argo Smart Routing latency analytics showing time-to-first-byte improvements argo: description: Network optimization features that speed up and improve reliability of traffic to your origins groups: smart-routing: description: Route traffic through the fastest network paths to your origin using real-time latency data tiered-caching: description: Reduce origin load by having upper-tier data centers serve cache misses before reaching your origin basin-catalog: description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines groups: credentials: description: Catalog access credentials for external query engines (Spark, Trino, etc.) maintenance-configs: description: Table maintenance settings — compaction schedules and snapshot expiration policies namespaces: description: Logical namespaces that group related tables within the data catalog namespaces.tables: description: Tables within catalog namespaces namespaces.tables.maintenance-configs: description: Table-level maintenance configurations and operations namespaces.tables.maintenance-runs: description: History of maintenance runs performed on tables billing: description: Account billing profiles and usage data for Cloudflare subscriptions and add-on services groups: profiles: description: Billing profile with payment method, address, and invoice preferences usage: description: Metered usage data for billed services — requests, bandwidth, and feature consumption botnet-feed: description: Botnet threat intelligence feeds — IP and ASN-level data on known command-and-control infrastructure groups: asn: description: ASN-level botnet activity data showing networks with known C2 infrastructure configs: description: Botnet feed subscription configuration and notification preferences builds: description: Build and deploy Workers from connected repositories, then inspect build status and logs. groups: deploy-hooks: description: Manage branch-specific HTTP hooks that start builds. limits: description: View build-minute availability and refresh information. logs: description: Retrieve build logs. repos: description: Manage source repository connections for Workers Builds. tokens: description: Manage credentials used by Workers Builds to deploy Workers. triggers: description: Configure how repository changes build and deploy Workers. versions: description: Find builds associated with Worker versions. workers: description: Manage repository-backed build configuration for Workers. cache: description: Purge cached content and configure Cache Reserve, tiered caching, and variant serving groups: origin-cloud-regions: description: Manage Origin Cloud Regions routing and failover configurations settings: description: Configure Cache Reserve, tiered caching, and variant serving settings.regional-tiered-cache: description: Restrict tiered cache topology to data centers within a specific geographic region settings.reserve: description: Persistent storage tier that keeps cached assets even after eviction from edge caches settings.smart-tiered-cache: description: Automatically determine the best upper-tier data centers for tiered cache topology settings.variants: description: Serve different cached versions of an image based on the Accept header (WebP, AVIF, etc.) client-side-security: description: Client-Side Security — monitor JavaScript, connections, and cookies on your pages for supply-chain attacks groups: connections: description: Third-party connections made by scripts on your pages — track data exfiltration risks cookies: description: Cookies set by your pages with classification and same-site attribute tracking policies: description: Content Security Policies that control which scripts and connections are allowed on your pages scripts: description: JavaScript files detected on your pages with change tracking and malicious code detection settings: description: Fine tune Client-Side Security behaviors cloud-connector: description: Route traffic from Cloudflare directly to cloud provider services (AWS, Azure, GCP) without origin servers groups: rules: description: Routing rules that map request patterns to cloud provider endpoints cloudforce-one: description: Detection rule management APIs groups: binary-storage: description: Upload and retrieve malware samples and suspicious binaries for analysis requests: description: Additional request operations — priority listing and asset creation rules: description: Rule management operations groups: approvals: description: Approval workflow operations email: description: Email rule operations exemptions: description: Exemption rule operations managed: description: Managed rule operations stats: description: Rule statistics operations tree: description: Rule navigation tree operations scans: description: Scan URLs, IPs, and domains for threat intelligence indicators containers: description: Deploy and manage Containers applications on Cloudflare's global network groups: applications: description: Manage Containers applications applications.instances: description: Inspect Containers instances belonging to applications applications.rollouts: description: Manage rollouts for scheduler-backed applications applications.versions: description: Inspect versions of scheduler-backed applications registries: description: Manage Containers image registries registries.credentials: description: Generate image registry credentials content-scan: description: Malicious uploads detection, scan uploaded content in HTTP requests for malware and malicious payloads groups: expressions: description: Custom expressions that tell the scanner how to reach content objects it cannot parse on its own custom-pages: description: Manage custom error and challenge pages and their assets for accounts and zones groups: account-custom-pages: description: Manage account-level custom pages account-custom-pages.preview-tokens: description: Preview tokens for account-level custom pages assets: description: Manage account- and zone-level custom assets zone-custom-pages: description: Manage zone-level custom pages zone-custom-pages.preview-tokens: description: Preview tokens for zone-level custom pages d1: description: D1 is Cloudflare's managed, serverless database with SQLite's SQL semantics, built-in disaster recovery, and Worker and HTTP API access. groups: time-travel: description: use specific point-in-time backups of your D1 database x-forge-epilogue: For more information about Time Travel, see https://developers.cloudflare.com/d1/reference/time-travel diagnostics: description: Network diagnostic tools — traceroutes from Cloudflare's edge and endpoint health checks groups: endpoint-healthchecks: description: Monitor external endpoint availability with periodic HTTP/HTTPS health checks traceroutes: description: Run traceroutes from Cloudflare data centers to diagnose network path issues email-routing: description: Route incoming email to verified destination addresses or Workers with routing rules, catch-all behavior, and managed DNS records groups: addresses: description: Verified destination email addresses that can receive forwarded mail dns: description: Inspect or unlock the DNS records required by Email Routing rules: description: Match incoming email addresses and forward messages to destination mailboxes or Workers settings: description: Inspect and update Email Routing settings email-security: description: Cloud email security — investigate threats, manage allow/block policies, and detect phishing groups: analytics: description: Analytics and reporting — monthly report and per-day breakdowns of threat activity bulk-actions: description: Asynchronous jobs that move or release every message matching a search — create, monitor, and manage bulk jobs investigate: description: Search and investigate email messages — view detections, traces, raw content, and take remediation actions phishguard: description: PhishGuard user-reported phishing reports — view detected threats for a date range settings: description: Email security configuration — block senders, allow policies, content policies, domains, trusted domains, impersonation registry, and URL handling submissions: description: Reclassify submissions — track user and team reports of false positives and missed detections email-sending: description: Send transactional email and manage sending subdomains and their DNS configuration groups: limits: description: Inspect account-level sending quotas and current usage subdomains: description: Configure sending subdomains and keep their DNS records healthy suppressions: description: Prevent delivery to suppressed addresses and manage the account suppression list filters: description: Filter expressions used by legacy firewall rules to match requests — prefer Rulesets for new configurations firewall: description: Legacy firewall rules, zone lockdowns, access rules, user-agent blocking, and WAF packages groups: access-rules: description: IP-based access rules that allow, block, challenge, or whitelist traffic globally or per-zone lockdowns: description: Zone lockdown rules that restrict access to URLs by IP address or range rules: description: Legacy firewall rules with filter expressions — prefer Rulesets for new configurations ua-rules: description: Block or challenge requests based on the User-Agent header string waf: description: Legacy WAF managed rule packages, rule groups, individual rules, and override configurations zone-access-rules: description: Zone-scoped IP access rules for blocking or allowing traffic google-tag-gateway: description: Google Tag Gateway operations groups: config: description: Google Tag Gateway config operations healthchecks: description: Standalone health checks that monitor origin server availability from Cloudflare's edge groups: previews: description: Test a health check configuration before deploying it to production hyperdrive: description: Accelerate access to existing databases by caching queries and pooling connections at the edge iam: description: Identity and access management — permission groups, resource groups, user groups, and SSO connectors groups: permission-groups: description: View the permission groups that can be assigned to API tokens and policies resource-groups: description: Define scopes that limit which account resources a policy or token can access sso: description: Configure single sign-on connectors to authenticate account members through an external identity provider user-groups: description: Organize account members into groups for easier permission assignment images: description: Store, resize, and deliver optimized images globally — variants, signing keys, and direct uploads groups: flows: description: Zone-level transformation flows that control how images are resized and optimized on delivery import: description: Import images from S3 keys: description: Manage signing keys for generating private image URLs variants: description: Manage named resize variants for transforming images on delivery intel: description: Threat intelligence lookups — IP reputation, domain info, ASN details, WHOIS, and indicator feeds groups: asn: description: ASN intelligence — ownership, geolocation, and subnet details for autonomous systems attack-surface-report: description: Attack surface intelligence — exposed assets, vulnerabilities, and infrastructure mapping dns: description: Passive DNS data showing historical DNS resolution records for domains domain-history: description: Historical domain registration and categorization changes over time domains: description: Domain intelligence — risk scores, categories, and associated infrastructure indicator-feeds: description: Threat indicator feeds — subscribe to and manage curated lists of malicious IPs, domains, and URLs ip-lists: description: Curated IP lists used for threat detection and policy enforcement ips: description: IP address intelligence — geolocation, risk assessment, and hosting provider details miscategorizations: description: Report and track domain miscategorization corrections whois: description: WHOIS registration data for domains including registrant, registrar, and nameservers k2: description: Durable, ordered event streams that you produce records to and consume from with subscriptions groups: streams: description: K2 streams, their retention, and the HTTP and Workers binding inputs used to produce records streams.subscriptions: description: Subscriptions that consume a K2 stream, with committed-position lag leaked-credential-checks: description: Detect compromised credentials in login requests by checking against known breach databases groups: detections: description: Custom detection locations that tell the WAF where to find usernames and passwords in requests load-balancers: description: Distribute traffic across origin pools with health monitoring, geo-steering, and failover groups: monitor-groups: description: Group monitors together for shared configuration and bulk management monitor-groups.references: description: List references to monitor groups used by load balancer pools monitors: description: Health check configurations that probe origin servers and determine pool availability monitors.previews: description: Health check configurations that probe origin servers and determine pool availability monitors.references: description: Health check configurations that probe origin servers and determine pool availability pools: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences pools.health: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences pools.references: description: Origin server pools with weighted traffic distribution, health thresholds, and geographic preferences previews: description: Preview the result of a health check monitor configuration before applying it regions: description: Geographic regions used for regional pool steering and traffic policies searches: description: Search across all load balancer resources (pools, monitors, load balancers) by name or reference logs: description: Log control, retention, and raw log access — CMB config, ray ID lookups, and received fields groups: control: description: Log control operations received: description: Received log operations magic-network-monitoring: description: Flow-based network traffic monitoring with configurable alerting rules and VPC flow ingestion groups: configs: description: Account-level monitoring configuration — sampling rates, thresholds, and notification settings rules: description: Monitoring rules that define traffic thresholds and trigger alerts or prefix advertisements vpc-flows: description: Ingest VPC flow logs from cloud providers for network visibility and anomaly detection magic-transit: description: DDoS-protected network transit — GRE/IPsec tunnels, static routes, Magic WAN sites, connectors, and packet captures groups: advanced-dns-protection: description: Advanced Dns Protection operations advanced-tcp-protection: description: Advanced Tcp Protection operations apps: description: Application-aware traffic policies for Magic WAN that steer traffic by app type bgp-filter-profiles: description: BGP filter profiles for controlling which routes are allowed or denied on Magic Transit tunnels bgp-settings: description: BGP settings for controlling default ASN and route redistribution on Magic Transit tunnels cf-interconnects: description: Cloudflare Network Interconnect (CNI) links for direct physical or virtual peering gre-tunnels: description: GRE tunnel endpoints that connect your network to Cloudflare for Magic Transit ipsec-tunnels: description: IPsec tunnel endpoints with pre-shared key management for encrypted transit pcaps: description: Packet capture requests for debugging traffic flowing through Magic Transit tunnels routes: description: Static routes that direct IP prefix traffic through specific GRE/IPsec tunnels sites: description: Magic WAN branch sites — base CRUD, LAN/WAN interface configuration, ACLs, connectors, app configuration, and NetFlow config mcp: description: Manage MCP portals and upstream MCP servers for Cloudflare Access AI controls groups: portals: description: Manage MCP portals, attached servers, and Code Mode settings servers: description: Manage upstream MCP servers, credentials, capabilities, and sync state network-interconnects: description: Physical and virtual private interconnects between your infrastructure and Cloudflare's network groups: cnis: description: Cloud Network Interconnect (CNI) connections — private links from cloud providers to Cloudflare interconnects: description: Physical cross-connect and partner interconnect sessions with LOA and status tracking settings: description: Account-level interconnect settings and default configurations slots: description: Available interconnect facility slots showing port capacity at Cloudflare data centers organizations: description: Multi-user organizations that group accounts, members, and shared settings under a single entity groups: account-organizations: description: List organizations associated with a specific account accounts: description: Accounts operations members: description: Members operations members-batch-create: description: Members Batch Create operations organization-profile: description: View and update the public profile information for an organization shares: description: Shares operations origin-post-quantum-encryption: description: Enable post-quantum key exchange for connections between Cloudflare and your origin server pages: description: Full-stack application hosting with Git-integrated builds, preview deployments, and custom domains groups: projects: description: Pages projects, deployments, build logs, and custom domain bindings pipelines: description: Ingest, transform, and route event streams into R2, analytics, or other destinations in real time groups: sinks: description: Destinations where pipeline data is written — R2 buckets, HTTP endpoints, or other storage streams: description: Inbound data streams that feed events into a pipeline for processing precursor: description: Precursor settings for a zone queues: description: Reliable message queuing between Workers — produce, consume, and batch-process messages at scale groups: consumers: description: Workers that automatically receive and process messages from a queue messages: description: Push messages to a queue and pull or acknowledge them from consumers purge: description: Remove all pending messages from a queue subscriptions: description: Manage queue subscriptions for event-driven message routing r2: description: S3-compatible object storage with zero egress fees — buckets, lifecycle rules, event notifications, and data migration groups: buckets: description: Create and configure R2 buckets including CORS, lifecycle, custom domains, event notifications, and object locks buckets.jobs: description: Create and inspect background jobs for an R2 bucket buckets.local-uploads: description: R2 bucket local upload configuration super-slurper: description: Migrate data from external S3-compatible storage into R2 buckets with resumable transfer jobs temporary-credentials: description: Generate short-lived S3-compatible credentials scoped to specific buckets and operations r2-data-catalog: description: Iceberg-compatible data catalog for R2 — organize objects into tables and namespaces for SQL query engines groups: credentials: description: Catalog access credentials for external query engines (Spark, Trino, etc.) maintenance-configs: description: Table maintenance settings — compaction schedules and snapshot expiration policies namespaces: description: Logical namespaces that group related tables within the data catalog namespaces.tables: description: Tables within catalog namespaces namespaces.tables.maintenance-configs: description: Table-level maintenance configurations and operations namespaces.tables.maintenance-runs: description: History of maintenance runs performed on tables radar: description: Internet-wide traffic intelligence — BGP, DNS, HTTP trends, attack data, and network quality insights groups: agent-readiness: description: Agent readiness summary statistics across the Cloudflare network ai: description: AI inference trends and model usage statistics across the Cloudflare network annotations: description: Radar annotations marking significant Internet events (outages, cable cuts, etc.) as112: description: AS112 DNS sinkhole statistics — reverse DNS query volumes for private address space attacks: description: DDoS and application-layer attack trends, vectors, and target analysis bgp: description: BGP routing data — prefix announcements, AS-level stats, route leaks, and hijack events bots: description: Internet-wide bot traffic trends, categories, and distribution statistics ct: description: Certificate Transparency log monitoring and newly-issued certificate discovery datasets: description: Downloadable Radar datasets for offline analysis and research dns: description: Global DNS query trends — top domains, resolver stats, and DNSSEC adoption email: description: Email security trends — DMARC/SPF/DKIM adoption, spam, and phishing statistics entities: description: Look up ASNs, IPs, domains, and locations with metadata and traffic summaries geolocations: description: Geographic location metadata used for regional traffic analysis http: description: HTTP protocol trends — TLS versions, HTTP versions, browser share, and OS distribution leaked-credentials: description: Leaked credential detection trends and exposure statistics netflows: description: Network-layer traffic flow data and volumetric trend analysis origins: description: Cloud and hosting origin providers (e.g. Amazon, by region) and their traffic metrics post-quantum: description: Post-quantum encryption adoption and deployment trends across the Internet quality: description: Internet connection quality metrics — speed, latency, and jitter by geography and ASN ranking: description: Top domain rankings based on DNS query popularity across the Cloudflare network robots-txt: description: Robots.txt adoption and crawler directive trends across the web search: description: Search Radar data across IPs, ASNs, domains, and locations tcp-resets-timeouts: description: TCP connection reset and timeout statistics indicating network health issues tlds: description: Top-level domain (TLD) metadata and performance trends traffic-anomalies: description: Detected traffic anomalies and unusual patterns in Internet traffic flows verified-bots: description: Catalog of known good bots (Googlebot, Bingbot, etc.) and their traffic patterns rate-limits: description: Legacy per-zone rate limiting rules — prefer Advanced Rate Limiting in Rulesets for new configurations realtime: description: Real-time audio, video, and data services on Cloudflare's global network groups: kit: description: SDK-backed meetings, participants, recordings, livestreams, and webhooks kit.analytics: description: Usage and livestream analytics for RealtimeKit applications kit.analytics.livestreams: description: Livestream analytics for RealtimeKit applications kit.analytics.livestreams.daily: description: Daily livestream analytics for RealtimeKit applications kit.analytics.usage: description: Usage analytics for RealtimeKit applications kit.apps: description: RealtimeKit applications that group meetings, sessions, and configuration kit.livestreams: description: Independent and meeting-based livestreams and their sessions kit.livestreams.sessions: description: Sessions for RealtimeKit livestreams kit.meetings: description: Meetings, participants, access tokens, and meeting livestreams kit.meetings.active: description: Live meeting state and participant controls kit.meetings.active.polls: description: Polls for active meeting sessions kit.meetings.livestream: description: Livestream operations associated with RealtimeKit meetings kit.meetings.participants: description: Participants in RealtimeKit meetings kit.meetings.participants.tokens: description: Access tokens for RealtimeKit meeting participants kit.presets: description: Reusable meeting configuration for media, permissions, and interface behavior kit.recordings: description: Meeting and participant-track recordings and recording controls kit.recordings.active: description: Active recordings for RealtimeKit meetings kit.recordings.tracks: description: Participant-track recordings for RealtimeKit meetings kit.sessions: description: Historical session data, participants, chat, transcripts, and summaries kit.sessions.chat: description: Chat messages from historical RealtimeKit sessions kit.sessions.livestreams: description: Livestreams associated with historical RealtimeKit sessions kit.sessions.participants: description: Participants in historical RealtimeKit sessions kit.sessions.peers: description: Peer details from historical RealtimeKit sessions kit.sessions.summaries: description: Summaries of historical RealtimeKit sessions kit.sessions.transcripts: description: Transcripts from historical RealtimeKit sessions kit.webhooks: description: Webhook endpoints and supported events for RealtimeKit notifications kit.webhooks.events: description: Supported events for RealtimeKit webhooks moq: description: MoQ relays for publishing and subscribing to media streams moq.relays: description: Relays are isolated MoQ scopes that carry media between publishers and subscribers moq.relays.tokens: description: Tokens that authorize publishers and subscribers to connect to a relay sfu: description: SFU apps that route WebRTC media and data between participants sfu.apps: description: SFU application namespaces for sessions and tracks turn: description: TURN keys that help clients traverse NATs and firewalls turn.keys: description: Keys used to generate short-lived TURN credentials request-tracers: description: Trace how a request would be processed through Cloudflare's rules and configuration pipeline groups: traces: description: Simulate request processing to debug rule matches, transforms, and routing decisions resource-sharing: description: Share Cloudflare resources (zones, accounts) across organizations with granular access controls groups: recipients: description: Update share recipients resources: description: Individual resources (zones, configs) that have been shared with recipients rules: description: Resources used by Cloudflare rules and rulesets groups: lists: description: Custom account-level lists of IPs, hostnames, ASNs, or redirects used in rule expressions rum: description: Real User Measurement (Web Analytics) — track page loads, Core Web Vitals, and visitor metrics groups: rules: description: Rules that control which pages and paths are tracked by Web Analytics site-info: description: Web Analytics sites — register domains and get the JavaScript beacon snippet scim: description: SCIM 2.0 provisioning — manage users, groups, and identity provider sync for your account groups: groups: description: Groups operations resource-types: description: Resource Types operations schemas: description: Schemas operations service-provider-config: description: Service Provider Config operations users: description: Users operations secrets-store: description: Centralized secret management — store API keys, tokens, and credentials for use across Workers and other products groups: quota: description: Account quota limits for secrets stores, secrets count, and storage capacity secrets: description: Encrypted key-value secrets within a store. Pass --store-id to scope. stores: description: Secret stores that hold encrypted key-value secrets accessible by Workers and services security-center: description: Security posture dashboard — view and manage security insights, misconfigurations, and vulnerabilities groups: insights: description: Security findings and recommendations across your account — DNS, SSL, WAF misconfigurations, etc. zone-insights: description: Zone-scoped security insights — counts by class, severity, type, and dismissal security-txt: description: Manage the /.well-known/security.txt file that tells security researchers how to report vulnerabilities smart-shield: description: Smart Shield settings, health checks, and cache reserve management groups: cache-reserve-clear: description: Cache Reserve Clear operations health-checks: description: Health checks operations spectrum: description: Proxy and protect arbitrary TCP/UDP applications through Cloudflare's network with DDoS mitigation groups: analytics: description: Real-time and historical connection analytics for Spectrum applications apps: description: Spectrum application configurations that map protocols and ports to origin servers speed: description: Observatory speed tests — run Lighthouse audits, track performance trends, and schedule recurring tests groups: availabilities: description: Check which speed test regions and configurations are available for your zone pages: description: Tested pages with their performance history, trends, and individual test results schedule: description: Scheduled recurring speed tests that automatically run at regular intervals ssl: description: SSL/TLS certificate management — certificate packs, Universal SSL, verification, and TLS mode recommendations groups: automatic-upgrader: description: SSL automatic mode enrollment — get or update automatic SSL/TLS upgrader settings recommendations: description: Get the recommended SSL/TLS encryption mode based on your origin server's certificate configuration stream: description: Video encoding, storage, and delivery — upload, live-stream, clip, caption, and embed video at scale groups: audio-tracks: description: Add, edit, or remove additional audio tracks on a video captions: description: Upload, generate, or retrieve captions and subtitles for videos in multiple languages clip: description: Create a new video clip from an existing video by specifying start and end times copy: description: Import a video from a URL into Stream for processing and delivery direct-upload: description: Generate a tokenized URL that lets end-users upload video directly to Stream downloads: description: Create downloadable MP4 renditions of a video for offline viewing embed: description: Retrieve the HTML embed code snippet for a video keys: description: Signing keys used to generate short-lived signed URLs for private video playback live-inputs: description: Enable and disable live input streams token: description: Generate short-lived signed URL tokens for secure private video playback typed-downloads: description: Type-specific stream download creation and deletion videos: description: Aggregate video storage usage statistics for the account watermarks: description: Watermark profiles that overlay an image on every video in the account webhooks: description: Webhook notifications for video lifecycle events (ready, error, etc.) tenants: description: Multi-tenant account management — manage tenant accounts, entitlements, and memberships groups: account-types: description: Account Types operations accounts: description: Accounts operations entitlements: description: Entitlements operations memberships: description: Memberships operations turnstile: description: CAPTCHA-free bot verification widgets that protect forms and APIs without degrading user experience groups: widgets: description: Turnstile widget configurations — site keys, secret rotation, and challenge mode settings url-scanner: description: Scan URLs for phishing, malware, and other threats — submit scans and retrieve detailed results groups: response: description: Response operations responses: description: Raw HTTP response data captured during URL scans scan: description: Scan operations scans: description: URL scan requests and results — submit URLs for analysis and retrieve threat verdicts user: description: Your Cloudflare user profile, invitations, organizations, billing, and personal API tokens groups: billing: description: View billing history and payment profile for your user (deprecated — prefer account-level billing) firewall: description: Firewall operations load-balancers.monitors: description: Load Balancers operations load-balancers.monitors.preview: description: Load Balancers operations load-balancers.monitors.references: description: Load Balancers operations load-balancers.pools: description: Load Balancers operations load-balancers.pools.edit.pools: description: Load Balancers operations load-balancers.pools.health: description: Load Balancers operations load-balancers.pools.preview: description: Load Balancers operations load-balancers.pools.references: description: Load Balancers operations load-balancers.preview: description: Load Balancers operations load-balancing-analytics.events: description: Load Balancing Analytics operations subscriptions: description: View and manage zone-level plan subscriptions owned by your user tenants: description: Tenants operations tokens: description: Create and manage personal API tokens scoped to your user for programmatic API access user.analytics: description: User-level traffic analytics — aggregated totals and timeseries across all zones vectorize: description: Globally distributed vector database for building semantic search, recommendations, and RAG applications on Workers groups: deprecated-indexes: description: Deprecated v1 Vectorize index operations metadata-index: description: Metadata indexes for filtered vector search waiting-rooms: description: Virtual queues that throttle traffic to your site during peak demand with customizable waiting pages groups: account-waiting-rooms: description: Account-scoped waiting room listing events: description: Scheduled events that temporarily override waiting room settings for sales, launches, etc. page: description: Custom HTML waiting page templates and preview rendering rules: description: Rules that bypass or modify waiting room behavior for specific request patterns settings: description: Zone-level waiting room defaults and cookie configuration statuses: description: Real-time queue status showing active users, queued users, and estimated wait times workflows: description: Durable, multi-step workflows that run on Workers with automatic retries and state persistence groups: instances: description: Workflow instance operations versions: description: Workflow version operations zaraz: description: Server-side tag manager — load third-party tools (analytics, pixels, etc.) from Cloudflare's edge without client-side JS groups: config: description: Full Zaraz configuration including tools, triggers, and variables for the zone default: description: Default Zaraz configuration template used as a starting point for new zones export: description: Export the current Zaraz configuration as a portable JSON document history: description: Configuration version history — browse and restore previous Zaraz configurations publish: description: Publish pending Zaraz configuration changes to make them live on the zone workflow: description: Workflow state for Zaraz configuration changes (draft vs. published) zero-trust: description: Cloudflare's SASE platform — secure access, device posture, DLP, tunnels, gateway policies, and network segmentation groups: dex: description: Digital Experience Monitoring — synthetic tests, fleet-wide device metrics, and network path diagnostics dlp.custom-prompt-topics: description: Data Loss Prevention - manage custom prompt topics for AI-based content detection dlp.data-classes: description: Data Loss Prevention - manage data classes used to classify sensitive information dlp.data-tag-categories: description: Data Loss Prevention - manage categories that organize data tags dlp.data-tag-category-templates: description: Data Loss Prevention - browse templates for creating data tag categories dlp.data-tags: description: Data Loss Prevention - manage tags used to classify and organize sensitive data dlp.datasets: description: Data Loss Prevention - manage datasets, versions, and uploads dlp.document-fingerprints: description: Data Loss Prevention - manage document fingerprints for detecting matching documents dlp.email.account-mapping: description: Data Loss Prevention - configure account mappings for outbound email scanning dlp.email.rules: description: Data Loss Prevention - manage outbound email scanning rules and their priorities dlp.entries: description: Data Loss Prevention - list and manage detection entries dlp.limits: description: Data Loss Prevention - view account limits and resource quotas dlp.patterns: description: Data Loss Prevention - validate regular expressions used for content detection dlp.profiles: description: Data Loss Prevention - list and retrieve profiles dlp.profiles.custom: description: Data Loss Prevention - manage custom profiles dlp.profiles.predefined: description: Data Loss Prevention - manage predefined profiles dlp.sensitivity-group-templates: description: Data Loss Prevention - browse templates for creating sensitivity groups dlp.sensitivity-groups: description: Data Loss Prevention - manage sensitivity groups and their level ordering dlp.sensitivity-levels: description: Data Loss Prevention - manage sensitivity levels within sensitivity groups dlp.settings: description: Data Loss Prevention - manage account-level settings dlp.validators: description: Data Loss Prevention - list and retrieve content validators dlp.validators.proximity-words: description: Data Loss Prevention - manage proximity-word validators risk-scoring: description: User Risk Scoring - retrieve and reset user risk scores risk-scoring.behaviours: description: User Risk Scoring - manage behaviors used to calculate user risk scores risk-scoring.integrations: description: User Risk Scoring - manage integrations that provide risk score signals risk-scoring.integrations.references: description: User Risk Scoring - retrieve integrations by external reference risk-scoring.summary: description: User Risk Scoring - retrieve account risk score summaries zones: description: Zones are domains on Cloudflare — list, create, and configure domain settings groups: aegis: description: Aegis operations fonts: description: Fonts operations origin-h2-max-streams: description: Origin H2 Max Streams operations origin-max-http-version: description: Origin Max Http Version operations origin-tls-compliance-modes: description: Manage zone Origin TLS Compliance Modes setting rum: description: Rum operations speed-brain: description: Speed Brain operations