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 D1 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: D1
paths:
  /accounts/{account_id}/d1/database:
    get:
      operationId: d1-list-databases
      summary: List D1 Databases
      description: List D1 databases in your account.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_account-identifier'
      - name: name
        in: query
        schema:
          description: a database name to search for.
          type: string
      - name: page
        in: query
        schema:
          description: Page number of paginated results.
          type: number
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          description: Number of items per page.
          type: number
          default: 1000
          maximum: 10000
          minimum: 10
      responses:
        '200':
          description: List D1 databases response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/d1_database-response'
                    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
        4XX:
          description: List D1 databases response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - D1
      x-api-token-group:
      - D1 Read
      - D1 Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: d1
      x-fern-sdk-method-name: list
      x-forge-epilogue: This command acts on remote D1 Databases.
      x-forge-globals:
      - alias: v
        description: Show version number
        name: version
        required:
          default: false
        type: boolean
      - description: Run as if Wrangler was started in the specified directory instead of the current working directory
        name: cwd
        required:
          default: .
        type: string
      - alias: c
        description: Path to Wrangler configuration file
        name: config
        required:
          default: ./wrangler.toml
        type: string
      - alias: e
        description: Environment to use for operations, and for selecting .env and .dev.vars files
        name: env
        required:
          default: dev
        type: string
      - description: Path to an .env file to load
        name: env-file
        required:
          default: ./.env
        type: string
      - alias: x-provision
        description: 'Experimental: Enable automatic resource provisioning'
        name: experimental-provision
        required:
          default: true
        type: boolean
      - alias: x-auto-create
        description: Automatically provision draft bindings with new resources
        name: experimental-auto-create
        required:
          default: true
        type: boolean
    post:
      operationId: d1-create-database
      summary: Create D1 Database
      description: Create a new D1 database in your account.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_account-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                jurisdiction:
                  $ref: '#/components/schemas/d1_jurisdiction'
                name:
                  $ref: '#/components/schemas/d1_database-name'
                primary_location_hint:
                  $ref: '#/components/schemas/d1_primary-location-hint'
                read_replication:
                  $ref: '#/components/schemas/d1_read-replication-details-for-request'
              required:
              - name
      responses:
        '200':
          description: Returns the created D1 database's metadata
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/d1_database-details-response'
        4XX:
          description: Database details response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - D1
      x-api-token-group:
      - D1 Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: d1
      x-fern-sdk-method-name: create
      x-forge-epilogue: This command acts on remote D1 Databases.
      x-forge-globals:
      - alias: v
        description: Show version number
        name: version
        required:
          default: false
        type: boolean
      - description: Run as if Wrangler was started in the specified directory instead of the current working directory
        name: cwd
        required:
          default: .
        type: string
      - alias: c
        description: Path to Wrangler configuration file
        name: config
        required:
          default: ./wrangler.toml
        type: string
      - alias: e
        description: Environment to use for operations, and for selecting .env and .dev.vars files
        name: env
        required:
          default: dev
        type: string
      - description: Path to an .env file to load
        name: env-file
        required:
          default: ./.env
        type: string
      - alias: x-provision
        description: 'Experimental: Enable automatic resource provisioning'
        name: experimental-provision
        required:
          default: true
        type: boolean
      - alias: x-auto-create
        description: Automatically provision draft bindings with new resources
        name: experimental-auto-create
        required:
          default: true
        type: boolean
  /accounts/{account_id}/d1/database/{database_id}:
    delete:
      operationId: d1-delete-database
      summary: Delete D1 Database
      description: Delete a D1 database.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_account-identifier'
      - name: database_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_database-identifier'
      responses:
        '200':
          description: Delete D1 database response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    result:
                      type:
                      - object
                      - 'null'
                      enum:
                      - null
        4XX:
          description: Delete D1 database response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - D1
      x-api-token-group:
      - D1 Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: d1
      x-fern-sdk-method-name: delete
      x-forge-epilogue: This command acts on remote D1 Databases.
      x-forge-globals:
      - alias: v
        description: Show version number
        name: version
        required:
          default: false
        type: boolean
      - description: Run as if Wrangler was started in the specified directory instead of the current working directory
        name: cwd
        required:
          default: .
        type: string
      - alias: c
        description: Path to Wrangler configuration file
        name: config
        required:
          default: ./wrangler.toml
        type: string
      - alias: e
        description: Environment to use for operations, and for selecting .env and .dev.vars files
        name: env
        required:
          default: dev
        type: string
      - description: Path to an .env file to load
        name: env-file
        required:
          default: ./.env
        type: string
      - alias: x-provision
        description: 'Experimental: Enable automatic resource provisioning'
        name: experimental-provision
        required:
          default: true
        type: boolean
      - alias: x-auto-create
        description: Automatically provision draft bindings with new resources
        name: experimental-auto-create
        required:
          default: true
        type: boolean
      x-forge-require-confirmation: This permanently deletes the D1 database and all of its data.
    get:
      operationId: d1-get-database
      summary: Get D1 Database
      description: Get details for a specific D1 database.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_account-identifier'
      - name: database_id
        in: path
        required: true
        schema:
          oneOf:
          - $ref: '#/components/schemas/d1_database-identifier'
          - $ref: '#/components/schemas/d1_database-name'
      - name: fields
        in: query
        description: 'Comma-separated list of fields to include in the response. When omitted,

          all fields are returned.

          '
        schema:
          type: array
          items:
            enum:
            - uuid
            - name
            - created_at
            - version
            - jurisdiction
            - num_tables
            - file_size
            - running_in_region
            - read_replication
            type: string
        example: uuid,name,version
        explode: false
        style: form
      responses:
        '200':
          description: Database details response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/d1_database-details-response'
        4XX:
          description: Database details response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - D1
      x-api-token-group:
      - D1 Read
      - D1 Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: d1
      x-fern-sdk-method-name: get
      x-forge-epilogue: This command acts on remote D1 Databases.
      x-forge-globals:
      - alias: v
        description: Show version number
        name: version
        required:
          default: false
        type: boolean
      - description: Run as if Wrangler was started in the specified directory instead of the current working directory
        name: cwd
        required:
          default: .
        type: string
      - alias: c
        description: Path to Wrangler configuration file
        name: config
        required:
          default: ./wrangler.toml
        type: string
      - alias: e
        description: Environment to use for operations, and for selecting .env and .dev.vars files
        name: env
        required:
          default: dev
        type: string
      - description: Path to an .env file to load
        name: env-file
        required:
          default: ./.env
        type: string
      - alias: x-provision
        description: 'Experimental: Enable automatic resource provisioning'
        name: experimental-provision
        required:
          default: true
        type: boolean
      - alias: x-auto-create
        description: Automatically provision draft bindings with new resources
        name: experimental-auto-create
        required:
          default: true
        type: boolean
    patch:
      operationId: d1-update-partial-database
      summary: Update D1 Database partially
      description: Partially update a D1 database's configuration.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_account-identifier'
      - name: database_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_database-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/d1_database-update-partial-request-body'
      responses:
        '200':
          description: Database details response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/d1_database-details-response'
        4XX:
          description: Update D1 database response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - D1
      x-api-token-group:
      - D1 Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: d1
      x-fern-sdk-method-name: edit
      x-forge-globals:
      - alias: v
        description: Show version number
        name: version
        required:
          default: false
        type: boolean
      - description: Run as if Wrangler was started in the specified directory instead of the current working directory
        name: cwd
        required:
          default: .
        type: string
      - alias: c
        description: Path to Wrangler configuration file
        name: config
        required:
          default: ./wrangler.toml
        type: string
      - alias: e
        description: Environment to use for operations, and for selecting .env and .dev.vars files
        name: env
        required:
          default: dev
        type: string
      - description: Path to an .env file to load
        name: env-file
        required:
          default: ./.env
        type: string
      - alias: x-provision
        description: 'Experimental: Enable automatic resource provisioning'
        name: experimental-provision
        required:
          default: true
        type: boolean
      - alias: x-auto-create
        description: Automatically provision draft bindings with new resources
        name: experimental-auto-create
        required:
          default: true
        type: boolean
      x-forge-hidden: true
    put:
      operationId: d1-update-database
      summary: Update D1 Database
      description: Update a D1 database's configuration.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_account-identifier'
      - name: database_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_database-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/d1_database-update-request-body'
      responses:
        '200':
          description: Database details response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/d1_database-details-response'
        4XX:
          description: Update D1 database response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - D1
      x-api-token-group:
      - D1 Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: d1
      x-fern-sdk-method-name: update
      x-forge-epilogue: This command acts on remote D1 Databases.
      x-forge-globals:
      - alias: v
        description: Show version number
        name: version
        required:
          default: false
        type: boolean
      - description: Run as if Wrangler was started in the specified directory instead of the current working directory
        name: cwd
        required:
          default: .
        type: string
      - alias: c
        description: Path to Wrangler configuration file
        name: config
        required:
          default: ./wrangler.toml
        type: string
      - alias: e
        description: Environment to use for operations, and for selecting .env and .dev.vars files
        name: env
        required:
          default: dev
        type: string
      - description: Path to an .env file to load
        name: env-file
        required:
          default: ./.env
        type: string
      - alias: x-provision
        description: 'Experimental: Enable automatic resource provisioning'
        name: experimental-provision
        required:
          default: true
        type: boolean
      - alias: x-auto-create
        description: Automatically provision draft bindings with new resources
        name: experimental-auto-create
        required:
          default: true
        type: boolean
  /accounts/{account_id}/d1/database/{database_id}/export:
    post:
      operationId: d1-export-database
      summary: Export D1 Database as SQL
      description: 'Export the SQL contents of a D1 database and return a URL where they 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.'
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_account-identifier'
      - name: database_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_database-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              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:
                  type: object
                  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.'
                      type: array
                      items:
                        type: string
                        x-auditable: true
                output_format:
                  description: Specifies that you will poll this endpoint until the export completes
                  type: string
                  enum:
                  - polling
                  x-auditable: true
              required:
              - output_format
      responses:
        '200':
          description: Polled successfully, task no longer running (errored or complete)
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    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
                          type: array
                          items:
                            type: string
                            x-auditable: true
                        result:
                          description: Only present when status = 'complete'
                          type: object
                          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
                        status:
                          type: string
                          enum:
                          - complete
                          - error
                          x-auditable: true
                        success:
                          type: boolean
                          x-auditable: true
                        type:
                          type: string
                          enum:
                          - export
                          x-auditable: true
        '202':
          description: Polled successfully, task is currently running
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    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
                          type: array
                          items:
                            type: string
                            x-auditable: true
                        status:
                          type: string
                          enum:
                          - active
                          x-auditable: true
                        success:
                          type: boolean
                          x-auditable: true
                        type:
                          type: string
                          enum:
                          - export
                          x-auditable: true
        4XX:
          description: Poll failed (API error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - D1
      x-fern-availability: generally-available
      x-fern-ignore: true
      x-fern-sdk-group-name: d1
      x-fern-sdk-method-name: export
      x-forge-epilogue: This command acts on remote D1 Databases.
      x-forge-globals:
      - alias: v
        description: Show version number
        name: version
        required:
          default: false
        type: boolean
      - description: Run as if Wrangler was started in the specified directory instead of the current working directory
        name: cwd
        required:
          default: .
        type: string
      - alias: c
        description: Path to Wrangler configuration file
        name: config
        required:
          default: ./wrangler.toml
        type: string
      - alias: e
        description: Environment to use for operations, and for selecting .env and .dev.vars files
        name: env
        required:
          default: dev
        type: string
      - description: Path to an .env file to load
        name: env-file
        required:
          default: ./.env
        type: string
      - alias: x-provision
        description: 'Experimental: Enable automatic resource provisioning'
        name: experimental-provision
        required:
          default: true
        type: boolean
      - alias: x-auto-create
        description: Automatically provision draft bindings with new resources
        name: experimental-auto-create
        required:
          default: true
        type: boolean
  /accounts/{account_id}/d1/database/{database_id}/import:
    post:
      operationId: d1-import-database
      summary: Import SQL into your D1 Database
      description: 'Generate a temporary URL for uploading an SQL file to, then instruct the D1 to import it

        and poll it for status updates. Imports block the D1 for their duration.'
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_account-identifier'
      - name: database_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_database-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - properties:
                  action:
                    description: Indicates you have a new SQL file to upload.
                    type: string
                    enum:
                    - init
                    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
                required:
                - action
                - etag
                title: init
                type: object
              - properties:
                  action:
                    description: Indicates you've finished uploading to tell the D1 to start consuming it
                    type: string
                    enum:
                    - ingest
                    x-auditable: true
                  etag:
                    description: 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
                required:
                - action
                - etag
                - filename
                title: ingest
                type: object
              - properties:
                  action:
                    description: Indicates you've finished uploading to tell the D1 to start consuming it
                    type: string
                    enum:
                    - poll
                    x-auditable: true
                  current_bookmark:
                    description: This identifies the currently-running import, checking its status.
                    type: string
                    x-auditable: true
                required:
                - action
                - current_bookmark
                title: poll
                type: object
      responses:
        '200':
          description: Successful action. Import is either ready to start, under way, or finished (succeeded or failed).
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    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
                          type: array
                          items:
                            type: string
                            x-auditable: true
                        result:
                          description: Only present when status = 'complete'
                          type: object
                          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/d1_query-meta'
                            num_queries:
                              description: The total number of queries that were executed during the import.
                              type: number
                              x-auditable: true
                        status:
                          type: string
                          enum:
                          - complete
                          - error
                          x-auditable: true
                        success:
                          type: boolean
                          x-auditable: true
                        type:
                          type: string
                          enum:
                          - import
                          x-auditable: true
                        upload_url:
                          description: The R2 presigned URL to use for uploading. Only returned when for the 'init' action.
                          type: string
        '202':
          description: Polled successfully, task is currently running
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    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
                          type: array
                          items:
                            type: string
                            x-auditable: true
                        status:
                          type: string
                          enum:
                          - active
                          x-auditable: true
                        success:
                          type: boolean
                          x-auditable: true
                        type:
                          type: string
                          enum:
                          - import
                          x-auditable: true
        4XX:
          description: Poll failed (API error)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - D1
      x-fern-availability: generally-available
      x-fern-ignore: true
      x-fern-sdk-group-name: d1
      x-fern-sdk-method-name: import
      x-forge-epilogue: This command acts on remote D1 Databases.
      x-forge-globals:
      - alias: v
        description: Show version number
        name: version
        required:
          default: false
        type: boolean
      - description: Run as if Wrangler was started in the specified directory instead of the current working directory
        name: cwd
        required:
          default: .
        type: string
      - alias: c
        description: Path to Wrangler configuration file
        name: config
        required:
          default: ./wrangler.toml
        type: string
      - alias: e
        description: Environment to use for operations, and for selecting .env and .dev.vars files
        name: env
        required:
          default: dev
        type: string
      - description: Path to an .env file to load
        name: env-file
        required:
          default: ./.env
        type: string
      - alias: x-provision
        description: 'Experimental: Enable automatic resource provisioning'
        name: experimental-provision
        required:
          default: true
        type: boolean
      - alias: x-auto-create
        description: Automatically provision draft bindings with new resources
        name: experimental-auto-create
        required:
          default: true
        type: boolean
  /accounts/{account_id}/d1/database/{database_id}/query:
    post:
      operationId: d1-query-database
      summary: Query D1 Database
      description: Execute a SQL query against a D1 database and return results as objects.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_account-identifier'
      - name: database_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_database-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/d1_batch-query'
      responses:
        '200':
          description: Query response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/d1_query-result-response'
        4XX:
          description: Query response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - D1
      x-api-token-group:
      - D1 Read
      - D1 Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: d1
      x-fern-sdk-method-name: query
      x-forge-epilogue: This command acts on remote D1 Databases.
      x-forge-globals:
      - alias: v
        description: Show version number
        name: version
        required:
          default: false
        type: boolean
      - description: Run as if Wrangler was started in the specified directory instead of the current working directory
        name: cwd
        required:
          default: .
        type: string
      - alias: c
        description: Path to Wrangler configuration file
        name: config
        required:
          default: ./wrangler.toml
        type: string
      - alias: e
        description: Environment to use for operations, and for selecting .env and .dev.vars files
        name: env
        required:
          default: dev
        type: string
      - description: Path to an .env file to load
        name: env-file
        required:
          default: ./.env
        type: string
      - alias: x-provision
        description: 'Experimental: Enable automatic resource provisioning'
        name: experimental-provision
        required:
          default: true
        type: boolean
      - alias: x-auto-create
        description: Automatically provision draft bindings with new resources
        name: experimental-auto-create
        required:
          default: true
        type: boolean
  /accounts/{account_id}/d1/database/{database_id}/raw:
    post:
      operationId: d1-raw-database-query
      summary: Raw D1 Database query
      description: Execute a SQL query against a D1 database and return result rows as arrays rather than objects. This is a performance-optimized version of the /query endpoint.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_account-identifier'
      - name: database_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_database-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/d1_batch-query'
      responses:
        '200':
          description: Raw query response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/d1_raw-result-response'
        4XX:
          description: Query response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - D1
      x-api-token-group:
      - D1 Read
      - D1 Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: d1
      x-fern-sdk-method-name: raw
      x-forge-epilogue: This command acts on remote D1 Databases.
      x-forge-globals:
      - alias: v
        description: Show version number
        name: version
        required:
          default: false
        type: boolean
      - description: Run as if Wrangler was started in the specified directory instead of the current working directory
        name: cwd
        required:
          default: .
        type: string
      - alias: c
        description: Path to Wrangler configuration file
        name: config
        required:
          default: ./wrangler.toml
        type: string
      - alias: e
        description: Environment to use for operations, and for selecting .env and .dev.vars files
        name: env
        required:
          default: dev
        type: string
      - description: Path to an .env file to load
        name: env-file
        required:
          default: ./.env
        type: string
      - alias: x-provision
        description: 'Experimental: Enable automatic resource provisioning'
        name: experimental-provision
        required:
          default: true
        type: boolean
      - alias: x-auto-create
        description: Automatically provision draft bindings with new resources
        name: experimental-auto-create
        required:
          default: true
        type: boolean
  /accounts/{account_id}/d1/database/{database_id}/time_travel/bookmark:
    get:
      operationId: d1-time-travel-get-bookmark
      summary: Get D1 database bookmark
      description: 'Retrieve 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.'
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_account-identifier'
      - name: database_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_database-identifier'
      - name: timestamp
        in: query
        description: An optional ISO 8601 timestamp. If provided, returns the nearest available bookmark at or before this timestamp. If omitted, returns the current bookmark.
        schema:
          $ref: '#/components/schemas/d1_time-travel-timestamp'
      responses:
        '200':
          description: Bookmark retrieved successfully
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    result:
                      type: object
                      properties:
                        bookmark:
                          $ref: '#/components/schemas/d1_time-travel-bookmark'
        4XX:
          description: Failed to retrieve bookmark
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - D1
      x-api-token-group:
      - D1 Read
      - D1 Write
      x-fern-availability: generally-available
      x-fern-sdk-group-name: d1.time-travel
      x-fern-sdk-method-name: get-bookmark
      x-forge-epilogue: This command acts on remote D1 Databases.
      x-forge-globals:
      - alias: v
        description: Show version number
        name: version
        required:
          default: false
        type: boolean
      - description: Run as if Wrangler was started in the specified directory instead of the current working directory
        name: cwd
        required:
          default: .
        type: string
      - alias: c
        description: Path to Wrangler configuration file
        name: config
        required:
          default: ./wrangler.toml
        type: string
      - alias: e
        description: Environment to use for operations, and for selecting .env and .dev.vars files
        name: env
        required:
          default: dev
        type: string
      - description: Path to an .env file to load
        name: env-file
        required:
          default: ./.env
        type: string
      - alias: x-provision
        description: 'Experimental: Enable automatic resource provisioning'
        name: experimental-provision
        required:
          default: true
        type: boolean
      - alias: x-auto-create
        description: Automatically provision draft bindings with new resources
        name: experimental-auto-create
        required:
          default: true
        type: boolean
  /accounts/{account_id}/d1/database/{database_id}/time_travel/restore:
    post:
      operationId: d1-time-travel-restore
      summary: Restore D1 Database to a bookmark or point in time
      description: Restore a D1 database to a previous point in time either via a bookmark or a timestamp.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_account-identifier'
      - name: database_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/d1_database-identifier'
      - name: bookmark
        in: query
        description: A bookmark to restore the database to. Required if `timestamp` is not provided.
        schema:
          $ref: '#/components/schemas/d1_time-travel-bookmark'
      - name: timestamp
        in: query
        description: An ISO 8601 timestamp to restore the database to. Required if `bookmark` is not provided.
        schema:
          $ref: '#/components/schemas/d1_time-travel-timestamp'
      responses:
        '200':
          description: Database restored successfully
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/d1_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/d1_time-travel-restore-response'
        4XX:
          description: Restore operation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/d1_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - D1
      x-fern-availability: generally-available
      x-fern-sdk-group-name: d1.time-travel
      x-fern-sdk-method-name: restore
      x-forge-epilogue: This command acts on remote D1 Databases.
      x-forge-globals:
      - alias: v
        description: Show version number
        name: version
        required:
          default: false
        type: boolean
      - description: Run as if Wrangler was started in the specified directory instead of the current working directory
        name: cwd
        required:
          default: .
        type: string
      - alias: c
        description: Path to Wrangler configuration file
        name: config
        required:
          default: ./wrangler.toml
        type: string
      - alias: e
        description: Environment to use for operations, and for selecting .env and .dev.vars files
        name: env
        required:
          default: dev
        type: string
      - description: Path to an .env file to load
        name: env-file
        required:
          default: ./.env
        type: string
      - alias: x-provision
        description: 'Experimental: Enable automatic resource provisioning'
        name: experimental-provision
        required:
          default: true
        type: boolean
      - alias: x-auto-create
        description: Automatically provision draft bindings with new resources
        name: experimental-auto-create
        required:
          default: true
        type: boolean
      x-forge-require-confirmation: This reverts the D1 database to a previous point in time. Data written after the bookmark will be lost.
components:
  schemas:
    d1_database-version:
      type: string
      example: production
      pattern: ^(alpha|beta|production)$
      x-auditable: true
    d1_raw-result-response:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/d1_query-meta'
        results:
          type: object
          properties:
            columns:
              type: array
              items:
                type: string
            rows:
              type: array
              items:
                items:
                  anyOf:
                  - type: number
                  - type: string
                  - type: object
                type: array
        success:
          type: boolean
    d1_file-size:
      description: The D1 database's size, in bytes.
      type: number
      example: 12
      x-auditable: true
    d1_messages:
      type: array
      items:
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      example: []
    d1_database-identifier:
      description: D1 database identifier (UUID).
      type: string
      example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
      readOnly: true
      x-auditable: true
    d1_read-replication-details-for-response:
      description: Configuration for D1 read replication.
      type: object
      properties:
        mode:
          description: The read replication mode for the database. Mode 'auto' denotes that D1 creates replicas and automatically places them around the world. Mode 'disabled' denotes that no database replicas are used.
          type: string
          example: auto
          enum:
          - auto
          - disabled
          x-auditable: true
      required:
      - mode
    d1_time-travel-restore-response:
      description: Response from a time travel restore operation.
      type: object
      properties:
        bookmark:
          allOf:
          - $ref: '#/components/schemas/d1_time-travel-bookmark'
          - 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.
          type: string
          example: Database restored successfully
          x-auditable: true
        previous_bookmark:
          allOf:
          - $ref: '#/components/schemas/d1_time-travel-bookmark'
          - description: The bookmark representing the state of the database before the restore operation. Can be used to undo the restore if needed.
    d1_batch-query:
      description: A single query object or a batch query object
      oneOf:
      - $ref: '#/components/schemas/d1_single-query'
      - properties:
          batch:
            type: array
            items:
              $ref: '#/components/schemas/d1_single-query'
        required:
        - batch
        title: multiple queries
        type: object
    d1_served-by-region:
      description: Region location hint of the database instance that handled the query.
      type: string
      example: EEUR
      enum:
      - WNAM
      - ENAM
      - WEUR
      - EEUR
      - APAC
      - OC
      x-auditable: true
    d1_params:
      type: array
      items:
        type: string
      example:
      - firstParam
      - secondParam
    d1_primary-location-hint:
      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.
      type: string
      example: wnam
      enum:
      - wnam
      - enam
      - weur
      - eeur
      - apac
      - oc
      x-auditable: true
    d1_database-name:
      description: D1 database name.
      type: string
      example: my-database
      pattern: ^[a-zA-Z0-9][a-zA-Z0-9_-]*$
      x-auditable: true
    d1_table-count:
      description: The number of tables in the D1 database. This count is no longer accurate and should not be relied upon.
      type: number
      example: 12
      deprecated: true
      x-auditable: true
    d1_database-update-request-body:
      type: object
      properties:
        read_replication:
          $ref: '#/components/schemas/d1_read-replication-details-for-request'
      required:
      - read_replication
    d1_api-response-common-failure:
      type: object
      properties:
        errors:
          example:
          - code: 7003
            message: No route for the URI
          allOf:
          - $ref: '#/components/schemas/d1_messages'
          minLength: 1
        messages:
          example: []
          allOf:
          - $ref: '#/components/schemas/d1_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
    d1_read-replication-details-for-request:
      description: Configuration for D1 read replication.
      type: object
      properties:
        mode:
          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).
          type: string
          example: auto
          enum:
          - auto
          - disabled
          x-auditable: true
      required:
      - mode
      x-stainless-terraform-configurability: computed_optional
    d1_api-response-common:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/d1_messages'
        messages:
          $ref: '#/components/schemas/d1_messages'
        result:
          type: object
        success:
          description: Whether the API call was successful
          type: boolean
          example: true
          enum:
          - true
      required:
      - success
      - errors
      - messages
      - result
    d1_time-travel-bookmark:
      description: A bookmark representing a specific state of the database at a specific point in time.
      type: string
      example: 00000001-00000002-00004e2f-0a83ea2fceebc654de0640c422be4653
      x-auditable: true
    d1_database-response:
      type: object
      properties:
        created_at:
          $ref: '#/components/schemas/d1_created-at'
        jurisdiction:
          $ref: '#/components/schemas/d1_jurisdiction-nullable'
        name:
          $ref: '#/components/schemas/d1_database-name'
        uuid:
          $ref: '#/components/schemas/d1_database-identifier'
        version:
          $ref: '#/components/schemas/d1_database-version'
    d1_jurisdiction:
      description: Specify the location to restrict the D1 database to run and store data. If this option is present, the location hint is ignored.
      type: string
      example: eu
      enum:
      - eu
      - fedramp
      - us
      x-auditable: true
    d1_created-at:
      description: Specifies the timestamp the resource was created as an ISO8601 string.
      type: string
      format: date-time
      example: '2022-11-15T18:25:44.442097Z'
      readOnly: true
      x-auditable: true
    d1_query-result-response:
      type: object
      properties:
        meta:
          $ref: '#/components/schemas/d1_query-meta'
        results:
          type: array
          items:
            type: object
        success:
          type: boolean
    d1_sql:
      description: Your SQL query. Supports multiple statements, joined by semicolons, which will be executed as a batch.
      type: string
      example: SELECT * FROM myTable WHERE field = ? OR field = ?;
    d1_served-by-colo:
      description: The three letters airport code of the colo that handled the query.
      type: string
      example: LHR
      x-auditable: true
    d1_time-travel-timestamp:
      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.
      type: string
      format: date-time
      example: '2024-01-15T12:00:00Z'
      x-auditable: true
    d1_database-details-response:
      description: The details of the D1 database.
      type: object
      properties:
        created_at:
          $ref: '#/components/schemas/d1_created-at'
        file_size:
          $ref: '#/components/schemas/d1_file-size'
        jurisdiction:
          $ref: '#/components/schemas/d1_jurisdiction-nullable'
        name:
          $ref: '#/components/schemas/d1_database-name'
        num_tables:
          $ref: '#/components/schemas/d1_table-count'
        read_replication:
          $ref: '#/components/schemas/d1_read-replication-details-for-response'
        uuid:
          $ref: '#/components/schemas/d1_database-identifier'
        version:
          $ref: '#/components/schemas/d1_database-version'
    d1_account-identifier:
      description: Account identifier tag.
      type: string
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      x-auditable: true
    d1_database-update-partial-request-body:
      type: object
      properties:
        read_replication:
          $ref: '#/components/schemas/d1_read-replication-details-for-request'
    d1_jurisdiction-nullable:
      description: Specify the location to restrict the D1 database to run and store data. If this option is present, the location hint is ignored.
      type:
      - string
      - 'null'
      example: eu
      enum:
      - eu
      - fedramp
      - us
      x-auditable: true
    d1_query-meta:
      type: object
      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/d1_served-by-colo'
        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/d1_served-by-region'
        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.
          type: object
          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
    d1_single-query:
      description: A single query with or without parameters
      type: object
      properties:
        params:
          $ref: '#/components/schemas/d1_params'
        sql:
          $ref: '#/components/schemas/d1_sql'
      required:
      - sql
      title: single query
  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