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 Custom Indicator Feeds 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: Custom Indicator Feeds
paths:
  /accounts/{account_id}/intel/indicator-feeds:
    get:
      operationId: custom-indicator-feeds-get-indicator-feeds
      summary: Get indicator feeds owned by this account
      description: Retrieves details for all accessible custom threat indicator feeds.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      responses:
        '200':
          description: Get indicator feeds response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_response'
        4XX:
          description: Get indicator feeds response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
      security:
      - api_email: []
        api_key: []
      tags:
      - Custom Indicator Feeds
      x-api-token-group:
      - Intel Write
      - Intel Read
      x-fern-availability: generally-available
      x-fern-sdk-group-name: intel.indicator-feeds
      x-fern-sdk-method-name: list
      x-forge-hidden: true
    post:
      operationId: custom-indicator-feeds-create-indicator-feeds
      summary: Create new indicator feed
      description: Creates a new custom threat indicator feed for sharing threat intelligence data.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_create_feed'
      responses:
        '200':
          description: Create indicator feed response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_create_feed_response'
        4XX:
          description: Get indicator feeds failure response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_create_feed_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
      security:
      - api_email: []
        api_key: []
      tags:
      - Custom Indicator Feeds
      x-fern-availability: generally-available
      x-fern-sdk-group-name: intel.indicator-feeds
      x-fern-sdk-method-name: create
      x-forge-hidden: true
  /accounts/{account_id}/intel/indicator-feeds/permissions/add:
    put:
      operationId: custom-indicator-feeds-add-permission
      summary: Grant permission to indicator feed
      description: Grants access permissions for a custom threat indicator feed to other accounts.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_permissions_request'
      responses:
        '200':
          description: Get indicator feed metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_permissions_response'
        4XX:
          description: Get indicator feeds response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_permissions_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
      security:
      - api_email: []
        api_key: []
      tags:
      - Custom Indicator Feeds
      x-fern-availability: generally-available
      x-fern-sdk-group-name: intel.indicator-feeds.permissions
      x-fern-sdk-method-name: create
      x-forge-hidden: true
  /accounts/{account_id}/intel/indicator-feeds/permissions/createProvider:
    put:
      operationId: custom-indicator-feeds-create-provider
      summary: Create indicator feed provider
      description: Creates a new indicator feed provider for an account. Only available to Intel accounts.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_create_provider_request'
      responses:
        '200':
          description: Create provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_create_provider_response'
        4XX:
          description: Create provider response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_create_provider_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
      security:
      - api_email: []
        api_key: []
      tags:
      - Custom Indicator Feeds
      x-fern-availability: generally-available
      x-fern-sdk-group-name: intel.indicator-feeds.providers
      x-fern-sdk-method-name: create
      x-forge-hidden: true
  /accounts/{account_id}/intel/indicator-feeds/permissions/remove:
    put:
      operationId: custom-indicator-feeds-remove-permission
      summary: Revoke permission to indicator feed
      description: Revokes access permissions for a custom threat indicator feed.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_permissions_request'
      responses:
        '200':
          description: Get indicator feed metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_permissions_response'
        4XX:
          description: Get indicator feeds response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_permissions_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
      security:
      - api_email: []
        api_key: []
      tags:
      - Custom Indicator Feeds
      x-fern-availability: generally-available
      x-fern-sdk-group-name: intel.indicator-feeds.permissions
      x-fern-sdk-method-name: delete
      x-forge-hidden: true
      x-forge-require-confirmation: This operation destructively removes a permission entry.
  /accounts/{account_id}/intel/indicator-feeds/permissions/view:
    get:
      operationId: custom-indicator-feeds-view-permissions
      summary: List indicator feed permissions
      description: Lists current access permissions for custom threat indicator feeds.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      responses:
        '200':
          description: Get indicator feed metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_permission_list_item_response'
        4XX:
          description: Get indicator feeds response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_permission_list_item_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
      security:
      - api_email: []
        api_key: []
      tags:
      - Custom Indicator Feeds
      x-api-token-group:
      - Intel Write
      - Intel Read
      x-fern-availability: generally-available
      x-fern-sdk-group-name: intel.indicator-feeds.permissions
      x-fern-sdk-method-name: list
      x-forge-hidden: true
  /accounts/{account_id}/intel/indicator-feeds/{feed_id}:
    get:
      operationId: custom-indicator-feeds-get-indicator-feed-metadata
      summary: Get indicator feed metadata
      description: Retrieves details for a specific custom threat indicator feed.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      - name: feed_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      responses:
        '200':
          description: Get indicator feed metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_metadata_response'
        4XX:
          description: Get indicator feeds response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_metadata_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
      security:
      - api_email: []
        api_key: []
      tags:
      - Custom Indicator Feeds
      x-api-token-group:
      - Intel Write
      - Intel Read
      x-fern-availability: generally-available
      x-fern-sdk-group-name: intel.indicator-feeds
      x-fern-sdk-method-name: get
      x-forge-hidden: true
    put:
      operationId: custom-indicator-feeds-update-indicator-feed-metadata
      summary: Update indicator feed metadata
      description: Revises details for a specific custom threat indicator feed.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      - name: feed_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/custom-indicator-feeds_update_public_field_request'
      responses:
        '200':
          description: Get update public field response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_update_public_field_response'
        4XX:
          description: Get update public field response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_update_public_field_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
      security:
      - api_email: []
        api_key: []
      tags:
      - Custom Indicator Feeds
      x-fern-availability: generally-available
      x-fern-sdk-group-name: intel.indicator-feeds
      x-fern-sdk-method-name: update
      x-forge-hidden: true
  /accounts/{account_id}/intel/indicator-feeds/{feed_id}/data:
    get:
      operationId: custom-indicator-feeds-get-indicator-feed-data
      summary: Get indicator feed data
      description: Retrieves the raw data entries in a custom threat indicator feed.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      - name: feed_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      responses:
        '200':
          description: Get indicator feed metadata
          content:
            text/csv:
              schema:
                type: string
        4XX:
          description: Get indicator feeds response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
      security:
      - api_email: []
        api_key: []
      tags:
      - Custom Indicator Feeds
      x-api-token-group:
      - Intel Write
      - Intel Read
      x-fern-availability: generally-available
      x-fern-sdk-group-name: intel.indicator-feeds
      x-fern-sdk-method-name: data
      x-forge-hidden: true
  /accounts/{account_id}/intel/indicator-feeds/{feed_id}/download:
    get:
      operationId: custom-indicator-feeds-download-indicator-feed-data
      summary: Download indicator feed data
      description: Downloads the content of a custom threat indicator feed.
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      - name: feed_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      responses:
        '200':
          description: Get indicator feed metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_update_feed_response'
        4XX:
          description: Get indicator feeds response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
      security:
      - api_email: []
        api_key: []
      tags:
      - Custom Indicator Feeds
      x-api-token-group:
      - Intel Write
      - Intel Read
      x-fern-availability: generally-available
      x-fern-sdk-group-name: intel.indicator-feeds.downloads
      x-fern-sdk-method-name: get
      x-forge-hidden: true
  /accounts/{account_id}/intel/indicator-feeds/{feed_id}/snapshot:
    put:
      operationId: custom-indicator-feeds-update-indicator-feed-data
      summary: Update indicator feed data
      description: 'Revises the raw data entries in a custom threat indicator feed.


        Accepts both plain and gzipped STIX2/CRDF bodies. Gzip is

        detected by RFC 1952 magic bytes (`0x1f 0x8b`) and/or a `.gz`

        filename suffix (case-insensitive) — either signal alone is

        sufficient to trigger the gzip path; if the body is not valid

        gzip, the upload fails fast. Customers are encouraged to gzip

        larger uploads — the api-gateway 500 MB body cap applies to

        the on-the-wire (compressed) size, so gzip lets a single

        upload carry several GiB of decompressed STIX.'
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      - name: feed_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      - name: Cf-Async-Upload
        in: header
        description: 'Set to the literal value `1` to enqueue the upload and receive a

          `202` response with a polling URL. Any other value uses the legacy

          synchronous response.

          '
        schema:
          type: string
          enum:
          - '1'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                source:
                  description: 'The file to upload. Either a plain STIX2/CRDF body

                    or a gzipped one (recognised by `0x1f 0x8b` magic

                    bytes or a `.gz` filename suffix).

                    '
                  type: string
                  example: '@/Users/me/test.stix2.gz'
      responses:
        '200':
          description: Get indicator feed metadata
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_update_feed_response'
        '202':
          description: Upload accepted for asynchronous processing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_enqueue_upload_response'
        '413':
          description: 'Decompressed upload exceeds the maximum allowed size. The

            server caps the decompressed body at a configured limit

            (default 6 GiB) as a gzip-bomb defence; this response is

            returned before any feed state changes. Resubmit a smaller

            (or non-pathologically-compressed) body.

            '
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
        4XX:
          description: Get indicator feeds response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
      security:
      - api_email: []
        api_key: []
      tags:
      - Custom Indicator Feeds
      x-fern-availability: generally-available
      x-fern-sdk-group-name: intel.indicator-feeds.snapshots
      x-fern-sdk-method-name: update
      x-forge-hidden: true
  /accounts/{account_id}/intel/indicator-feeds/{feed_id}/uploads/{upload_id}:
    get:
      operationId: custom-indicator-feeds-get-upload-status
      summary: Get indicator feed upload status
      description: 'Polls an asynchronously accepted upload. Continue polling after the

        recommended `poll_after_seconds` delay until status is `Unified` or

        `Error`. `Unified` is returned only after the durable loader finishes.'
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_identifier'
      - name: feed_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
      - name: upload_id
        in: path
        required: true
        schema:
          type: integer
          format: int64
      responses:
        '200':
          description: Current upload status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-indicator-feeds_upload_status_response'
        4XX:
          description: Upload status lookup failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-indicator-feeds_upload_status_response'
                - $ref: '#/components/schemas/custom-indicator-feeds_api_response_common_failure'
      security:
      - api_email: []
        api_key: []
      tags:
      - Custom Indicator Feeds
      x-api-token-group:
      - Intel Write
      - Intel Read
components:
  schemas:
    custom-indicator-feeds_identifier:
      description: Identifier
      type: string
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      readOnly: true
      x-auditable: true
    custom-indicator-feeds_update_public_field_request:
      properties:
        description:
          description: The new description of the feed
          type: string
          example: This is an example description
          x-auditable: true
        is_attributable:
          description: The new is_attributable value of the feed
          type: boolean
          example: true
          x-auditable: true
        is_downloadable:
          description: The new is_downloadable value of the feed
          type: boolean
          example: true
          x-auditable: true
        is_public:
          description: The new is_public value of the feed
          type: boolean
          example: true
          x-auditable: true
        name:
          description: The new name of the feed
          type: string
          example: indicator_list
          x-auditable: true
    custom-indicator-feeds_update_feed_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_update_feed'
    custom-indicator-feeds_description:
      description: The description of the example test
      type: string
      x-auditable: true
    custom-indicator-feeds_api-response-common:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/custom-indicator-feeds_messages-2'
        messages:
          $ref: '#/components/schemas/custom-indicator-feeds_messages-2'
        success:
          description: Whether the API call was successful.
          type: boolean
          example: true
          enum:
          - true
      required:
      - success
      - errors
      - messages
    custom-indicator-feeds_is_attributable:
      description: Whether the indicator feed can be attributed to a provider
      type: boolean
      x-auditable: true
    custom-indicator-feeds_create_feed:
      properties:
        description:
          $ref: '#/components/schemas/custom-indicator-feeds_description'
        name:
          $ref: '#/components/schemas/custom-indicator-feeds_name'
      example:
        description: example feed description
        name: example_feed_1
    custom-indicator-feeds_create_provider_request:
      properties:
        account_id:
          description: 'The numeric account ID to create the provider for. Distinct from the

            path `account_id` parameter, which carries the account identifier

            string used for routing.

            '
          type: integer
          example: 12345
          x-auditable: true
        name:
          description: The name of the provider
          type: string
          example: my_provider
          x-auditable: true
      required:
      - account_id
      - name
    custom-indicator-feeds_permission_list_item_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/custom-indicator-feeds_permission_list_item'
            example:
            - description: An important indicator list
              id: 1
              is_attributable: false
              is_downloadable: false
              is_public: false
              name: indicator_list_1
            - description: An even more important indicator list
              id: 2
              is_attributable: true
              is_downloadable: false
              is_public: true
              name: indicator_list_2
    custom-indicator-feeds_upload_status_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_upload_status'
    custom-indicator-feeds_create_feed_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_item'
    custom-indicator-feeds_provider_name:
      description: The provider of the indicator feed
      type: string
      x-auditable: true
    custom-indicator-feeds_permissions_request:
      properties:
        account_tag:
          description: The Cloudflare account tag of the account to change permissions on
          type: string
          example: 823f45f16fd2f7e21e1e054aga4d2859
          x-auditable: true
        feed_id:
          description: The ID of the feed to add/remove permissions on
          type: integer
          example: 1
          x-auditable: true
    custom-indicator-feeds_enqueue_upload:
      type: object
      properties:
        poll_url:
          description: 'Account-relative polling path. Prepend `/accounts/{account_id}`

            using the same account identifier and API host as the upload

            request. The path omits the account segment because the service

            does not have your account identifier in this context.

            '
          type: string
          example: /intel/indicator-feeds/12/uploads/12345
          x-auditable: true
        status:
          type: string
          example: Queued
          x-auditable: true
        upload_id:
          type: integer
          format: int64
          x-auditable: true
      required:
      - upload_id
      - status
      - poll_url
    custom-indicator-feeds_is_public:
      description: Whether the indicator feed is exposed to customers
      type: boolean
      x-auditable: true
    custom-indicator-feeds_indicator_feed_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_item'
            example:
            - created_on: '2023-05-12T12:21:56.777653Z'
              description: user specified description 1
              id: 1
              modified_on: '2023-06-18T03:13:34.123321Z'
              name: user_specified_name_1
            - created_on: '2023-05-21T21:43:52.867525Z'
              description: User specified description 2
              id: 2
              modified_on: '2023-06-28T18:46:18.764425Z'
              name: user_specified_name_2
    custom-indicator-feeds_permissions_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_permissions_update'
    custom-indicator-feeds_indicator_feed_item:
      properties:
        created_on:
          description: The date and time when the data entry was created
          type: string
          format: date-time
          x-auditable: true
        description:
          $ref: '#/components/schemas/custom-indicator-feeds_description'
        id:
          $ref: '#/components/schemas/custom-indicator-feeds_id'
        is_attributable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_attributable'
        is_downloadable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_downloadable'
        is_public:
          $ref: '#/components/schemas/custom-indicator-feeds_is_public'
        modified_on:
          description: The date and time when the data entry was last modified
          type: string
          format: date-time
          x-auditable: true
        name:
          $ref: '#/components/schemas/custom-indicator-feeds_name'
      example:
        created_on: '2023-05-12T12:21:56.777653Z'
        description: example feed description
        id: 1
        is_attributable: false
        is_downloadable: false
        is_public: false
        modified_on: '2023-06-18T03:13:34.123321Z'
        name: example_feed_1
    custom-indicator-feeds_permission_list_item:
      properties:
        description:
          $ref: '#/components/schemas/custom-indicator-feeds_description'
        id:
          $ref: '#/components/schemas/custom-indicator-feeds_id'
        is_attributable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_attributable'
        is_downloadable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_downloadable'
        is_public:
          $ref: '#/components/schemas/custom-indicator-feeds_is_public'
        name:
          $ref: '#/components/schemas/custom-indicator-feeds_name'
    custom-indicator-feeds_name:
      description: The name of the indicator feed
      type: string
      x-auditable: true
    custom-indicator-feeds_last_upload_summary:
      description: 'Summary of indicator counts from the last successful upload to this

        feed. Populated by the custom-threat-feeds loader at the end of each

        successful load. Absent (omitted) when no upload has completed

        successfully or the upload errored before the summary write.

        Surfaces silent-failure paths so operators can see when their

        indicators were dropped (popularity allowlist, expired valid_until,

        etc.) without reading loader logs.

        '
      type: object
      properties:
        persisted:
          description: 'Net delta applied to feed indicators by this upload. Snapshot

            uploads emit both *_added and *_removed; delta-add emits only

            *_added; delta-remove emits only *_removed.

            '
          type: object
          properties:
            domains_added:
              type: integer
              x-auditable: true
            domains_removed:
              type: integer
              x-auditable: true
            ips_added:
              type: integer
              x-auditable: true
            ips_removed:
              type: integer
              x-auditable: true
            urls_added:
              type: integer
              x-auditable: true
            urls_removed:
              type: integer
              x-auditable: true
        skipped:
          description: 'Counts of indicators that were uploaded but did not reach

            QuickSilver, broken down by reason.

            '
          type: object
          properties:
            allowlisted_domains:
              description: 'Domains filtered by the global popularity allowlist at QS

                provisioning time. Popular domains (bing.com, naver.com,

                etc.) are protected from custom-threat-feed enforcement.

                '
              type: integer
              x-auditable: true
            expired_indicators:
              description: 'Indicators in the upload whose valid_until is already in

                the past. These are not added to QS; the expiration cron

                handles cleanup.

                '
              type: integer
              x-auditable: true
            invalid_indicators:
              description: 'Reserved for future use. Currently always 0 — the unifier

                aborts the entire upload on a single bad indicator.

                '
              type: integer
              x-auditable: true
        uploaded:
          description: Indicator counts from the unified file the loader received
          type: object
          properties:
            domains:
              description: Number of domain indicators in the upload
              type: integer
              x-auditable: true
            ips:
              description: Number of IP indicators in the upload
              type: integer
              x-auditable: true
            urls:
              description: Number of URL indicators in the upload
              type: integer
              x-auditable: true
      x-auditable: true
    custom-indicator-feeds_permissions_update:
      properties:
        success:
          description: Whether the update succeeded or not
          type: boolean
          x-auditable: true
    custom-indicator-feeds_api-response-single:
      type: object
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-common'
    custom-indicator-feeds_api_response_common_failure:
      type: object
      properties:
        errors:
          example:
          - code: 7003
            message: No route for the URI
          allOf:
          - $ref: '#/components/schemas/custom-indicator-feeds_messages'
          minLength: 1
        messages:
          example: []
          allOf:
          - $ref: '#/components/schemas/custom-indicator-feeds_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
    custom-indicator-feeds_indicator_feed_metadata:
      properties:
        created_on:
          description: The date and time when the data entry was created
          type: string
          format: date-time
          x-auditable: true
        description:
          $ref: '#/components/schemas/custom-indicator-feeds_description'
        id:
          $ref: '#/components/schemas/custom-indicator-feeds_id'
        is_attributable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_attributable'
        is_downloadable:
          $ref: '#/components/schemas/custom-indicator-feeds_is_downloadable'
        is_public:
          $ref: '#/components/schemas/custom-indicator-feeds_is_public'
        last_upload_summary:
          $ref: '#/components/schemas/custom-indicator-feeds_last_upload_summary'
        latest_upload_error:
          description: 'Human-readable error message describing why the latest upload

            failed. Populated only when `latest_upload_status` is `Error`.

            Returns one of a small fixed set of category-level messages

            (invalid domain / IP / URL entries, malformed row or header,

            invalid valid_until timestamp, etc.) or the generic

            `Upload failed` for unknown or infrastructure-level errors.

            Never echoes raw error text from the underlying loader.

            Intel accounts receive the verbatim loader/API error text

            (including specific offending values) instead of these

            category-level messages.

            '
          type: string
          example: Feed contains one or more invalid domain entries. Check your feed for wildcards or other values that are not valid DNS names.
          x-auditable: true
        latest_upload_status:
          description: Status of the latest snapshot uploaded
          type: string
          enum:
          - Mirroring
          - Unifying
          - Loading
          - Provisioning
          - Complete
          - Error
          x-auditable: true
        modified_on:
          description: The date and time when the data entry was last modified
          type: string
          format: date-time
          x-auditable: true
        name:
          $ref: '#/components/schemas/custom-indicator-feeds_name'
        provider_id:
          $ref: '#/components/schemas/custom-indicator-feeds_provider_id'
        provider_name:
          $ref: '#/components/schemas/custom-indicator-feeds_provider_name'
      example:
        created_on: '2023-05-12T12:21:56.777653Z'
        description: example feed description
        id: 1
        is_attributable: false
        is_downloadable: false
        is_public: false
        last_upload_summary:
          persisted:
            domains_added: 2
            domains_removed: 1
            ips_added: 0
            ips_removed: 0
            urls_added: 0
            urls_removed: 0
          skipped:
            allowlisted_domains: 1
            expired_indicators: 0
            invalid_indicators: 0
          uploaded:
            domains: 3
            ips: 0
            urls: 0
        latest_upload_status: Complete
        modified_on: '2023-06-18T03:13:34.123321Z'
        name: example_feed_1
    custom-indicator-feeds_update_feed:
      properties:
        file_id:
          description: Feed id
          type: integer
          example: 1
          x-auditable: true
        filename:
          description: Name of the file unified in our system
          type: string
          example: snapshot_file.unified
          x-auditable: true
        poll_url:
          description: 'Account-relative polling path. Prepend `/accounts/{account_id}`

            using the same account identifier and API host as the upload

            request. The path omits the account segment because the service

            does not have your account identifier in this context.

            '
          type: string
          example: /intel/indicator-feeds/12/uploads/12345
          x-auditable: true
        status:
          description: 'Current status of the upload at the moment the request returned.

            This is NOT a terminal state: the file is unified inline, but the

            durable loader has only accepted it, so the upload is still

            `Unifying`. Poll `poll_url` until the status reaches a terminal

            value (`Unified` or `Error`).

            '
          type: string
          example: Unifying
          x-auditable: true
        upload_id:
          description: 'Identifier of the upload row, for polling this upload to a

            terminal state via `poll_url`.

            '
          type: integer
          format: int64
          example: 12345
          x-auditable: true
    custom-indicator-feeds_enqueue_upload_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_enqueue_upload'
    custom-indicator-feeds_update_public_field_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_item'
    custom-indicator-feeds_upload_status:
      type: object
      properties:
        attempts:
          type: integer
          minimum: 0
          x-auditable: true
        created_at:
          type: string
          format: date-time
          x-auditable: true
        error:
          description: Sanitized terminal error; omitted for non-error states.
          type: string
          x-auditable: true
        feed_id:
          $ref: '#/components/schemas/custom-indicator-feeds_feed_id'
        filename:
          type: string
          x-auditable: true
        poll_after_seconds:
          description: Recommended delay before the next poll; 0 means terminal.
          type: integer
          maximum: 30
          minimum: 0
          x-auditable: true
        stage:
          description: Sanitized durable loader stage, when available.
          type: string
          enum:
          - queued
          - loading
          - provisioning
          - retrying
          - complete
          - error
          x-auditable: true
        status:
          description: '`Unifying` while work is queued or active, optionally with attempt

            progress; `Unified` or `Error` when terminal.

            '
          type: string
          example: Unifying (attempt 2/3)
          x-auditable: true
        updated_at:
          type: string
          format: date-time
          x-auditable: true
        upload_id:
          type: integer
          format: int64
          x-auditable: true
      required:
      - upload_id
      - feed_id
      - filename
      - status
      - attempts
      - poll_after_seconds
    custom-indicator-feeds_feed_id:
      description: Indicator feed ID
      type: integer
      example: 12
      x-auditable: true
    custom-indicator-feeds_create_provider_result:
      properties:
        account_id:
          description: 'The numeric account ID the provider was created for. Distinct from

            the path `account_id` parameter, which carries the account

            identifier string used for routing.

            '
          type: integer
          example: 12345
          x-auditable: true
        name:
          description: The name of the provider
          type: string
          example: my_provider
          x-auditable: true
        provider_id:
          description: The unique identifier for the created provider
          type: integer
          example: 1
          x-auditable: true
      required:
      - account_id
      - name
      - provider_id
    custom-indicator-feeds_provider_id:
      description: The unique identifier for the provider
      type: integer
      example: 1
      x-auditable: true
    custom-indicator-feeds_create_provider_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_create_provider_result'
    custom-indicator-feeds_messages-2:
      type: array
      items:
        properties:
          code:
            type: integer
            minimum: 1000
          documentation_url:
            type: string
          message:
            type: string
          source:
            type: object
            properties:
              pointer:
                type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      example: []
    custom-indicator-feeds_indicator_feed_metadata_response:
      allOf:
      - $ref: '#/components/schemas/custom-indicator-feeds_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/custom-indicator-feeds_indicator_feed_metadata'
    custom-indicator-feeds_is_downloadable:
      description: Whether the indicator feed can be downloaded
      type: boolean
      x-auditable: true
    custom-indicator-feeds_id:
      description: The unique identifier for the indicator feed
      type: integer
      x-auditable: true
    custom-indicator-feeds_messages:
      type: array
      items:
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      example: []
  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