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 Access application-scoped policies 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: Access application-scoped policies
paths:
  /accounts/{account_id}/access/apps/{app_id}/policies:
    get:
      operationId: access-policies-list-access-app-policies
      summary: List Access application policies
      description: Lists Access policies configured for an application. Returns both exclusively scoped and reusable policies used by the application.
      parameters:
      - name: app_id
        in: path
        description: The application ID.
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      - $ref: '#/components/parameters/access_page'
      - name: per_page
        in: query
        schema:
          description: Number of results per page.
          type: integer
          default: 200
          maximum: 1000
      responses:
        '200':
          description: List Access application policies response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_response_collection-9'
        4XX:
          description: List Access application policies response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - Access application-scoped policies
      x-api-token-group:
      - 'Access: Apps and Policies Write'
      - 'Access: Apps and Policies Read'
      x-fern-availability: deprecated
      x-fern-sdk-group-name: zero-trust.access.applications.policies
      x-fern-sdk-method-name: list
    post:
      operationId: access-policies-create-an-access-policy
      summary: Create an Access application policy
      description: Creates a policy applying exclusive to a single application that defines the users or groups who can reach it. We recommend creating a reusable policy instead and subsequently referencing its ID in the application's 'policies' array.
      parameters:
      - name: app_id
        in: path
        description: The application ID.
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_app_policy_write_request'
      responses:
        '201':
          description: Create an Access application policy response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_single_response-10'
        4XX:
          description: Create an Access application policy response failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - Access application-scoped policies
      x-api-token-group:
      - 'Access: Apps and Policies Write'
      x-fern-availability: deprecated
      x-fern-ignore: true
      x-fern-sdk-group-name: zero-trust.access.applications.policies
      x-fern-sdk-method-name: create
  /accounts/{account_id}/access/apps/{app_id}/policies/{policy_id}:
    delete:
      operationId: access-policies-delete-an-access-policy
      summary: Delete an Access application policy
      description: Deletes an Access policy specific to an application. To delete a reusable policy, use the /accounts/{account_id}/policies/{uid} endpoint.
      parameters:
      - name: app_id
        in: path
        description: The application ID.
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: policy_id
        in: path
        description: The policy ID.
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '202':
          description: Delete an Access application policy response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
        4XX:
          description: Delete an Access application policy response failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - Access application-scoped policies
      x-api-token-group:
      - 'Access: Apps and Policies Write'
      x-fern-availability: deprecated
      x-fern-ignore: true
      x-fern-sdk-group-name: zero-trust.access.applications.policies
      x-fern-sdk-method-name: delete
    get:
      operationId: access-policies-get-an-access-policy
      summary: Get an Access application policy
      description: Fetches a single Access policy configured for an application. Returns both exclusively owned and reusable policies used by the application.
      parameters:
      - name: app_id
        in: path
        description: The application ID.
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: policy_id
        in: path
        description: The policy ID.
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: Get an Access policy response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_single_response-10'
        4XX:
          description: Get an Access policy response failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - Access application-scoped policies
      x-api-token-group:
      - 'Access: Apps and Policies Write'
      - 'Access: Apps and Policies Read'
      x-fern-availability: deprecated
      x-fern-sdk-group-name: zero-trust.access.applications.policies
      x-fern-sdk-method-name: get
    put:
      operationId: access-policies-update-an-access-policy
      summary: Update an Access application policy
      description: Updates an Access policy specific to an application. To update a reusable policy, use the /accounts/{account_id}/policies/{uid} endpoint.
      parameters:
      - name: app_id
        in: path
        description: The application ID.
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: policy_id
        in: path
        description: The policy ID.
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            examples:
              fido2_key_only:
                summary: Update a policy requiring a FIDO2 key
                value:
                  decision: allow
                  include:
                  - everyone: {}
                  mfa_config:
                    allowed_authenticators:
                    - ssh_fido2_key
                  name: Allow SSH users with a FIDO2 key
              piv_and_fido2_key:
                summary: Update a policy allowing a PIV key or FIDO2 key
                value:
                  decision: allow
                  include:
                  - everyone: {}
                  mfa_config:
                    allowed_authenticators:
                    - piv_key
                    - ssh_fido2_key
                  name: Allow SSH users with a PIV key or FIDO2 key
              piv_only:
                summary: Update a policy requiring a PIV key
                value:
                  decision: allow
                  include:
                  - everyone: {}
                  mfa_config:
                    allowed_authenticators:
                    - piv_key
                  name: Allow SSH users with a PIV key
            schema:
              $ref: '#/components/schemas/access_app_policy_write_request'
      responses:
        '200':
          description: Update an Access application policy response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_single_response-10'
        4XX:
          description: Update an Access application policy response failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - Access application-scoped policies
      x-api-token-group:
      - 'Access: Apps and Policies Write'
      x-fern-availability: deprecated
      x-fern-ignore: true
      x-fern-sdk-group-name: zero-trust.access.applications.policies
      x-fern-sdk-method-name: update
  /accounts/{account_id}/access/apps/{app_id}/policies/{policy_id}/make_reusable:
    put:
      operationId: access-policies-convert-reusable
      summary: Convert an Access application policy to a reusable policy
      description: Converts an application-scoped policy to a reusable policy. The policy will no longer be exclusively scoped to the application. Further updates to the policy should go through the /accounts/{account_id}/policies/{uid} endpoint.
      parameters:
      - name: app_id
        in: path
        description: The application ID.
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: policy_id
        in: path
        description: The policy ID.
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: Convert an Access application policy to a reusable policy
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_response_collection-9'
        4XX:
          description: Convert an Access application policy to a reusable policy failure.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      tags:
      - Access application-scoped policies
      x-api-token-group:
      - 'Access: Apps and Policies Write'
      x-fern-availability: generally-available
      x-fern-sdk-group-name: zero-trust.access.applications.policies
      x-fern-sdk-method-name: make-reusable
components:
  schemas:
    access_app_policy_request:
      type: object
      allOf:
      - properties:
          precedence:
            $ref: '#/components/schemas/access_precedence'
        type: object
      - $ref: '#/components/schemas/access_policy_req'
    access_infra_policy_req:
      type: object
      properties:
        connection_rules:
          $ref: '#/components/schemas/access_connection_rules_infra'
        mfa_config:
          $ref: '#/components/schemas/access_infra_mfa_config'
      allOf:
      - $ref: '#/components/schemas/access_base_policy_req'
    access_exclude-2:
      description: Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.
      type: array
      items:
        $ref: '#/components/schemas/access_rule'
      default: []
      x-stainless-collection-type: set
    access_user_risk_score_rule:
      description: Matches a user's risk score.
      type: object
      properties:
        user_risk_score:
          type: object
          properties:
            user_risk_score:
              description: A list of risk score levels to match. Values can be low, medium, high, or unscored.
              type: array
              items:
                enum:
                - low
                - medium
                - high
                - unscored
                type: string
              example:
              - low
              - medium
              minItems: 1
          required:
          - user_risk_score
      required:
      - user_risk_score
      title: User Risk Score
    access_saml_group_rule:
      description: 'Matches a SAML group.

        Requires a SAML identity provider.'
      type: object
      properties:
        saml:
          type: object
          properties:
            attribute_name:
              description: The name of the SAML attribute.
              type: string
              example: group
            attribute_value:
              description: The SAML attribute value to look for.
              type: string
              example: devs@cloudflare.com
            identity_provider_id:
              description: The ID of your SAML identity provider.
              type: string
              example: ea85612a-29c8-46c2-bacb-669d65136971
          required:
          - attribute_name
          - attribute_value
          - identity_provider_id
      required:
      - saml
      title: SAML group
    access_isolation_required:
      description: Require this application to be served in an isolated browser for users matching this policy. 'Client Web Isolation' must be on for the account in order to use this feature.
      type: boolean
      example: false
    access_messages:
      type: array
      items:
        properties:
          code:
            type: integer
            minimum: 1000
          documentation_url:
            type: string
          message:
            type: string
          source:
            type: object
            properties:
              pointer:
                type: string
        required:
        - code
        - message
        type: object
        uniqueItems: true
      example: []
    access_api-response-common-failure:
      type: object
      properties:
        errors:
          example:
          - code: 7003
            message: No route for the URI
          allOf:
          - $ref: '#/components/schemas/access_messages'
          minLength: 1
        messages:
          example: []
          allOf:
          - $ref: '#/components/schemas/access_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
    access_usernames:
      description: Contains the Unix usernames that may be used when connecting over SSH.
      type: array
      items:
        type: string
        x-auditable: true
      example:
      - root
      - ubuntu
    access_purpose_justification_required:
      description: Require users to enter a justification when they log in to the application.
      type: boolean
      example: true
    access_rdp_clipboard_format:
      description: Clipboard format for RDP connections.
      type: string
      enum:
      - text
      - file
      x-auditable: true
    access_domain_rule:
      description: Match an entire email domain.
      type: object
      properties:
        email_domain:
          type: object
          properties:
            domain:
              description: The email domain to match.
              type: string
              example: example.com
          required:
          - domain
      required:
      - email_domain
      title: Email domain
    access_app_policy_response:
      type: object
      allOf:
      - $ref: '#/components/schemas/access_policy_resp'
      - properties:
          account_id:
            $ref: '#/components/schemas/access_identifier'
          precedence:
            $ref: '#/components/schemas/access_precedence'
        type: object
    access_single_response-10:
      type: object
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/access_app_policy_result'
        type: object
    access_name-9:
      description: The name of the Access policy.
      type: string
      example: Allow devs
    access_external_evaluation_rule:
      description: Create Allow or Block policies which evaluate the user based on custom criteria.
      type: object
      properties:
        external_evaluation:
          type: object
          properties:
            evaluate_url:
              description: The API endpoint containing your business logic.
              type: string
              example: https://eval.example.com
            keys_url:
              description: The API endpoint containing the key that Access uses to verify that the response came from your API.
              type: string
              example: https://eval.example.com/keys
          required:
          - evaluate_url
          - keys_url
      required:
      - external_evaluation
      title: External Evaluation
    access_any_valid_service_token_rule:
      description: Matches any valid Access Service Token
      type: object
      properties:
        any_valid_service_token:
          description: An empty object which matches on all service tokens.
          type: object
          example: {}
          x-stainless-empty-object: true
      required:
      - any_valid_service_token
      title: Any Valid Service Token
    access_country_rule:
      description: Matches a specific country
      type: object
      properties:
        geo:
          type: object
          properties:
            country_code:
              description: The country code that should be matched.
              type: string
              example: US
          required:
          - country_code
      required:
      - geo
      title: Country
    access_api-response-common:
      type: object
      properties:
        errors:
          $ref: '#/components/schemas/access_messages'
        messages:
          $ref: '#/components/schemas/access_messages'
        success:
          description: Whether the API call was successful.
          type: boolean
          example: true
          enum:
          - true
      required:
      - success
      - errors
      - messages
    access_cloudflare_account_member_rule:
      description: 'Matches users who are members of a specific Cloudflare account.

        Requires a Cloudflare identity provider.'
      type: object
      properties:
        cloudflare_account_member:
          type: object
          properties:
            account_id:
              $ref: '#/components/schemas/access_identifier'
      required:
      - cloudflare_account_member
      title: Cloudflare Account Member
    access_azure_group_rule:
      description: 'Matches an Azure group.

        Requires an Azure identity provider.'
      type: object
      properties:
        azureAD:
          type: object
          properties:
            id:
              description: The ID of an Azure group.
              type: string
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
            identity_provider_id:
              description: The ID of your Azure identity provider.
              type: string
              example: ea85612a-29c8-46c2-bacb-669d65136971
          required:
          - id
          - identity_provider_id
      required:
      - azureAD
      title: Azure group
    access_login_method_rule:
      description: Matches a specific identity provider id.
      type: object
      properties:
        login_method:
          type: object
          properties:
            id:
              description: The ID of an identity provider.
              type: string
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
          required:
          - id
      required:
      - login_method
      title: Login Method
    access_api-response-collection:
      type: object
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      - properties:
          result_info:
            type: object
            properties:
              count:
                description: Total number of results for the requested service.
                type: number
                example: 1
              page:
                description: Current page within paginated list of results.
                type: number
                example: 1
              per_page:
                description: Number of results per page of results.
                type: number
                example: 20
              total_count:
                description: Total results available without any search parameters.
                type: number
                example: 2000
              total_pages:
                description: The number of total pages in the entire result set.
                type: number
                example: 100
        type: object
    access_include-2:
      description: Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.
      type: array
      items:
        $ref: '#/components/schemas/access_rule'
      default: []
      x-stainless-collection-type: set
    access_infra_mfa_config:
      description: Configures multi-factor authentication (MFA) settings for infrastructure applications.
      type: object
      properties:
        allowed_authenticators:
          description: Lists the MFA methods that users can authenticate with. For infrastructure applications, supported values are `piv_key` and `ssh_fido2_key`.
          type: array
          items:
            enum:
            - piv_key
            - ssh_fido2_key
            type: string
          example:
          - piv_key
          - ssh_fido2_key
        mfa_disabled:
          description: Indicates whether to disable MFA for this resource. This option is available at the application and policy level.
          type: boolean
          example: false
        session_duration:
          description: 'Defines the duration of an MFA session. Must be in minutes (m) or hours (h). Minimum: 0m. Maximum: 720h (30 days). Examples: `5m` or `24h`.'
          type: string
          example: 24h
      x-auditable: true
    access_device_posture_rule:
      description: Enforces a device posture rule has run successfully
      type: object
      properties:
        device_posture:
          type: object
          properties:
            account_id:
              description: The ID of the account that owns the device posture integration.
              allOf:
              - $ref: '#/components/schemas/access_identifier'
            integration_uid:
              description: The ID of a device posture integration.
              type: string
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
          required:
          - integration_uid
      required:
      - device_posture
      title: Device Posture
    access_approval_groups:
      description: Administrators who can approve a temporary authentication request.
      type: array
      items:
        $ref: '#/components/schemas/access_approval_group'
      example:
      - approvals_needed: 1
        email_addresses:
        - test1@cloudflare.com
        - test2@cloudflare.com
      - approvals_needed: 3
        email_list_uuid: 597147a1-976b-4ef2-9af0-81d5d007fc34
      x-stainless-collection-type: set
    access_connection_rules_rdp:
      description: The RDP-specific rules that define clipboard behavior for RDP connections.
      type: object
      properties:
        allowed_clipboard_local_to_remote_formats:
          $ref: '#/components/schemas/access_allowed_clipboard_local_to_remote_formats'
        allowed_clipboard_remote_to_local_formats:
          $ref: '#/components/schemas/access_allowed_clipboard_remote_to_local_formats'
      title: RDP Connection Rules
    access_uuid-2:
      description: The UUID of the policy
      type: string
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
    access_allowed_clipboard_remote_to_local_formats:
      description: Clipboard formats allowed when copying from remote RDP session to local machine.
      type: array
      items:
        $ref: '#/components/schemas/access_rdp_clipboard_format'
      example:
      - text
      - file
    access_access_group_rule:
      description: Matches an Access group.
      type: object
      properties:
        group:
          type: object
          properties:
            id:
              description: The ID of a previously created Access group.
              type: string
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
          required:
          - id
      required:
      - group
      title: Access groups
    access_require-2:
      description: Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.
      type: array
      items:
        $ref: '#/components/schemas/access_rule'
      default: []
      x-stainless-collection-type: set
    access_rule:
      type: object
      oneOf:
      - $ref: '#/components/schemas/access_access_group_rule'
      - $ref: '#/components/schemas/access_any_valid_service_token_rule'
      - $ref: '#/components/schemas/access_auth_context_rule'
      - $ref: '#/components/schemas/access_authentication_method_rule'
      - $ref: '#/components/schemas/access_azure_group_rule'
      - $ref: '#/components/schemas/access_certificate_rule'
      - $ref: '#/components/schemas/access_common_name_rule'
      - $ref: '#/components/schemas/access_country_rule'
      - $ref: '#/components/schemas/access_device_posture_rule'
      - $ref: '#/components/schemas/access_domain_rule'
      - $ref: '#/components/schemas/access_email_list_rule'
      - $ref: '#/components/schemas/access_email_rule'
      - $ref: '#/components/schemas/access_everyone_rule'
      - $ref: '#/components/schemas/access_external_evaluation_rule'
      - $ref: '#/components/schemas/access_github_organization_rule'
      - $ref: '#/components/schemas/access_gsuite_group_rule'
      - $ref: '#/components/schemas/access_login_method_rule'
      - $ref: '#/components/schemas/access_ip_list_rule'
      - $ref: '#/components/schemas/access_ip_rule'
      - $ref: '#/components/schemas/access_okta_group_rule'
      - $ref: '#/components/schemas/access_saml_group_rule'
      - $ref: '#/components/schemas/access_oidc_claim_rule'
      - $ref: '#/components/schemas/access_service_token_rule'
      - $ref: '#/components/schemas/access_linked_app_token_rule'
      - $ref: '#/components/schemas/access_user_risk_score_rule'
      - $ref: '#/components/schemas/access_cloudflare_account_member_rule'
    access_okta_group_rule:
      description: 'Matches an Okta group.

        Requires an Okta identity provider.'
      type: object
      properties:
        okta:
          type: object
          properties:
            identity_provider_id:
              description: The ID of your Okta identity provider.
              type: string
              example: ea85612a-29c8-46c2-bacb-669d65136971
            name:
              description: The name of the Okta group.
              type: string
              example: devs
          required:
          - name
          - identity_provider_id
      required:
      - okta
      title: Okta group
    access_response_collection-9:
      type: object
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/access_app_policy_result'
        type: object
    access_decision:
      description: The action Access will take if a user matches this policy. Infrastructure application policies can only use the Allow action.
      type: string
      example: allow
      enum:
      - allow
      - deny
      - non_identity
      - bypass
    access_auth_context_rule:
      description: 'Matches an Azure Authentication Context.

        Requires an Azure identity provider.'
      type: object
      properties:
        auth_context:
          type: object
          properties:
            ac_id:
              description: The ACID of an Authentication context.
              type: string
              example: ea85612a-29c8-46c2-bacb-669d65136971
            id:
              description: The ID of an Authentication context.
              type: string
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
            identity_provider_id:
              description: The ID of your Azure identity provider.
              type: string
              example: ea85612a-29c8-46c2-bacb-669d65136971
          required:
          - id
          - identity_provider_id
          - ac_id
      required:
      - auth_context
      title: Authentication Context
    access_purpose_justification_prompt:
      description: A custom message that will appear on the purpose justification screen.
      type: string
      example: Please enter a justification for entering this protected domain.
    access_approval_group:
      description: A group of email addresses that can approve a temporary authentication request.
      type: object
      properties:
        approvals_needed:
          description: The number of approvals needed to obtain access.
          type: number
          example: 1
          minimum: 0
        email_addresses:
          description: A list of emails that can approve the access request.
          type: array
          items:
            type: string
          example:
          - test@cloudflare.com
          - test2@cloudflare.com
        email_list_uuid:
          description: The UUID of an re-usable email list.
          type: string
      required:
      - approvals_needed
    access_precedence:
      description: 'The order of execution for this policy. Must be unique for each policy within an app.

        '
      type: integer
    access_uuid:
      description: UUID.
      type: string
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
      x-auditable: true
    access_ip_list_rule:
      description: Matches an IP address from a list.
      type: object
      properties:
        ip_list:
          type: object
          properties:
            id:
              description: The ID of a previously created IP list.
              type: string
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
          required:
          - id
      required:
      - ip_list
      title: IP list
    access_timestamp:
      type: string
      format: date-time
      example: '2014-01-01T05:20:00.12345Z'
      x-auditable: true
    access_base_policy_resp:
      type: object
      properties:
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        decision:
          $ref: '#/components/schemas/access_decision'
        exclude:
          $ref: '#/components/schemas/access_exclude-2'
        id:
          $ref: '#/components/schemas/access_uuid-2'
        include:
          $ref: '#/components/schemas/access_include-2'
        name:
          $ref: '#/components/schemas/access_name-9'
        require:
          $ref: '#/components/schemas/access_require-2'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
    access_linked_app_token_rule:
      description: Matches OAuth 2.0 access tokens issued by the specified Access OIDC SaaS application. Only compatible with non_identity and bypass decisions.
      type: object
      properties:
        linked_app_token:
          type: object
          properties:
            app_uid:
              description: The ID of an Access OIDC SaaS application
              type: string
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
          required:
          - app_uid
      required:
      - linked_app_token
      title: Linked App Token
    access_api-response-single:
      type: object
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
    access_session_duration-3:
      description: 'The amount of time that tokens issued for the application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.'
      type:
      - string
      - 'null'
      example: 24h
    access_ip_rule:
      description: Matches an IP address block.
      type: object
      properties:
        ip:
          type: object
          properties:
            ip:
              description: An IPv4 or IPv6 CIDR block.
              type: string
              example: 2400:cb00:21:10a::/64
          required:
          - ip
      required:
      - ip
      title: IP ranges
    access_everyone_rule:
      description: Matches everyone.
      type: object
      properties:
        everyone:
          description: An empty object which matches on all users.
          type: object
          example: {}
          x-stainless-empty-object: true
      required:
      - everyone
      title: Everyone
    access_connection_rules:
      description: The rules that define how users may connect to targets secured by your application.
      type: object
      properties:
        rdp:
          $ref: '#/components/schemas/access_connection_rules_rdp'
      title: Connection Rules
    access_policy_resp:
      type: object
      properties:
        approval_groups:
          $ref: '#/components/schemas/access_approval_groups'
        approval_required:
          $ref: '#/components/schemas/access_approval_required'
        connection_rules:
          $ref: '#/components/schemas/access_connection_rules'
        isolation_required:
          $ref: '#/components/schemas/access_isolation_required'
        mfa_config:
          $ref: '#/components/schemas/access_mfa_config'
        purpose_justification_prompt:
          $ref: '#/components/schemas/access_purpose_justification_prompt'
        purpose_justification_required:
          $ref: '#/components/schemas/access_purpose_justification_required'
        session_duration:
          $ref: '#/components/schemas/access_session_duration-3'
      allOf:
      - $ref: '#/components/schemas/access_base_policy_resp'
    access_base_policy_req:
      type: object
      properties:
        decision:
          $ref: '#/components/schemas/access_decision'
        exclude:
          $ref: '#/components/schemas/access_exclude-2'
        include:
          $ref: '#/components/schemas/access_include-2'
        name:
          $ref: '#/components/schemas/access_name-9'
        require:
          $ref: '#/components/schemas/access_require-2'
      required:
      - name
      - decision
      - include
    access_app_policy_result:
      anyOf:
      - $ref: '#/components/schemas/access_app_policy_response'
      - $ref: '#/components/schemas/access_infra_policy_resp'
    access_email_rule:
      description: Matches a specific email.
      type: object
      properties:
        email:
          type: object
          properties:
            email:
              description: The email of the user.
              type: string
              format: email
              example: test@example.com
          required:
          - email
      required:
      - email
      title: Email
    access_app_policy_write_request:
      anyOf:
      - $ref: '#/components/schemas/access_app_policy_request'
      - $ref: '#/components/schemas/access_infra_policy_req'
    access_gsuite_group_rule:
      description: 'Matches a group in Google Workspace.

        Requires a Google Workspace identity provider.'
      type: object
      properties:
        gsuite:
          type: object
          properties:
            email:
              description: The email of the Google Workspace group.
              type: string
              example: devs@cloudflare.com
            identity_provider_id:
              description: The ID of your Google Workspace identity provider.
              type: string
              example: ea85612a-29c8-46c2-bacb-669d65136971
          required:
          - email
          - identity_provider_id
      required:
      - gsuite
      title: Google Workspace group
    access_identifier:
      description: Identifier.
      type: string
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
      x-auditable: true
    access_email_list_rule:
      description: Matches an email address from a list.
      type: object
      properties:
        email_list:
          type: object
          properties:
            id:
              description: The ID of a previously created email list.
              type: string
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
          required:
          - id
      required:
      - email_list
      title: Email list
    access_authentication_method_rule:
      description: Enforce different MFA options
      type: object
      properties:
        auth_method:
          type: object
          properties:
            auth_method:
              description: The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176#section-2.
              type: string
              example: mfa
          required:
          - auth_method
      required:
      - auth_method
      title: Authentication method
    access_certificate_rule:
      description: Matches any valid client certificate.
      type: object
      properties:
        certificate:
          type: object
          example: {}
          x-stainless-empty-object: true
      example:
        certificate: {}
      required:
      - certificate
      title: Valid certificate
    access_infra_policy_resp:
      type: object
      properties:
        connection_rules:
          $ref: '#/components/schemas/access_connection_rules_infra'
        mfa_config:
          $ref: '#/components/schemas/access_infra_mfa_config'
      allOf:
      - $ref: '#/components/schemas/access_base_policy_resp'
    access_common_name_rule:
      description: Matches a specific common name.
      type: object
      properties:
        common_name:
          type: object
          properties:
            common_name:
              description: The common name to match.
              type: string
              example: james@example.com
          required:
          - common_name
      required:
      - common_name
      title: Common Name
    access_approval_required:
      description: Requires the user to request access from an administrator at the start of each session.
      type: boolean
      example: true
    access_connection_rules_infra:
      description: The rules that define how users may connect to the targets secured by your application.
      type: object
      properties:
        ssh:
          $ref: '#/components/schemas/access_connection_rules_ssh'
      title: Connection Rules
    access_mfa_config:
      description: Configures multi-factor authentication (MFA) settings.
      type: object
      properties:
        allowed_authenticators:
          description: Lists the MFA methods that users can authenticate with.
          type: array
          items:
            enum:
            - totp
            - biometrics
            - security_key
            type: string
          example:
          - totp
          - biometrics
          - security_key
        mfa_disabled:
          description: Indicates whether to disable MFA for this resource. This option is available at the application and policy level.
          type: boolean
          example: false
        session_duration:
          description: 'Defines the duration of an MFA session. Must be in minutes (m) or hours (h). Minimum: 0m. Maximum: 720h (30 days). Examples:`5m` or `24h`.'
          type: string
          example: 24h
      x-auditable: true
    access_allow_email_alias:
      description: Enables using Identity Provider email alias as SSH username.
      type: boolean
      x-auditable: true
    access_github_organization_rule:
      description: 'Matches a Github organization.

        Requires a Github identity provider.'
      type: object
      properties:
        github-organization:
          type: object
          properties:
            identity_provider_id:
              description: The ID of your Github identity provider.
              type: string
              example: ea85612a-29c8-46c2-bacb-669d65136971
            name:
              description: The name of the organization.
              type: string
              example: cloudflare
            team:
              description: The name of the team
              type: string
              example: api-team
          required:
          - name
          - identity_provider_id
      required:
      - github-organization
      title: Github organization
    access_id_response:
      type: object
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/access_uuid'
        type: object
    access_service_token_rule:
      description: Matches a specific Access Service Token
      type: object
      properties:
        service_token:
          type: object
          properties:
            token_id:
              description: The ID of a Service Token.
              type: string
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
          required:
          - token_id
      required:
      - service_token
      title: Service Token
    access_oidc_claim_rule:
      description: 'Matches an OIDC claim.

        Requires an OIDC identity provider.'
      type: object
      properties:
        oidc:
          type: object
          properties:
            claim_name:
              description: The name of the OIDC claim.
              type: string
              example: group
            claim_value:
              description: The OIDC claim value to look for.
              type: string
              example: devs@cloudflare.com
            identity_provider_id:
              description: The ID of your OIDC identity provider.
              type: string
              example: ea85612a-29c8-46c2-bacb-669d65136971
          required:
          - claim_name
          - claim_value
          - identity_provider_id
      required:
      - oidc
      title: OIDC claim
    access_policy_req:
      type: object
      properties:
        approval_groups:
          $ref: '#/components/schemas/access_approval_groups'
        approval_required:
          $ref: '#/components/schemas/access_approval_required'
        connection_rules:
          $ref: '#/components/schemas/access_connection_rules'
        isolation_required:
          $ref: '#/components/schemas/access_isolation_required'
        mfa_config:
          $ref: '#/components/schemas/access_mfa_config'
        purpose_justification_prompt:
          $ref: '#/components/schemas/access_purpose_justification_prompt'
        purpose_justification_required:
          $ref: '#/components/schemas/access_purpose_justification_required'
        session_duration:
          $ref: '#/components/schemas/access_session_duration-3'
      allOf:
      - $ref: '#/components/schemas/access_base_policy_req'
    access_connection_rules_ssh:
      description: The SSH-specific rules that define how users may connect to the targets secured by your application.
      type: object
      properties:
        allow_email_alias:
          $ref: '#/components/schemas/access_allow_email_alias'
        usernames:
          $ref: '#/components/schemas/access_usernames'
      required:
      - usernames
      title: SSH Connection Rules
    access_allowed_clipboard_local_to_remote_formats:
      description: Clipboard formats allowed when copying from local machine to remote RDP session.
      type: array
      items:
        $ref: '#/components/schemas/access_rdp_clipboard_format'
      example:
      - text
      - file
  parameters:
    access_page:
      in: query
      name: page
      schema:
        description: Page number of results.
        type: integer
        default: 1
  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