openapi: 3.0.3
info:
  title: Cloudflare / Accounts Zones API
  description: Needs description.
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  version: 4.0.0
servers:
- url: https://api.cloudflare.com/client/v4
  description: Client API
security:
- api_email: []
  api_key: []
- api_token: []
- user_service_key: []
tags:
- name: Zones
paths:
  /zones/{identifier}/access/certificates/{uuid}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete an mTLS certificate
      description: Deletes an mTLS certificate.
      operationId: zone-level-access-mtls-authentication-delete-an-mtls-certificate
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: Delete an mTLS certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_components-schemas-id_response'
        4XX:
          description: Delete an mTLS certificate response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get an mTLS certificate
      description: Fetches a single mTLS certificate.
      operationId: zone-level-access-mtls-authentication-get-an-mtls-certificate
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: Get an mTLS certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-single_response'
        4XX:
          description: Get an mTLS certificate response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update an mTLS certificate
      description: Updates a configured mTLS certificate.
      operationId: zone-level-access-mtls-authentication-update-an-mtls-certificate
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - associated_hostnames
              properties:
                associated_hostnames:
                  $ref: '#/components/schemas/access_associated_hostnames'
                name:
                  $ref: '#/components/schemas/access_certificates_components-schemas-name'
      responses:
        '200':
          description: Update an mTLS certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-single_response'
        4XX:
          description: Update an mTLS certificate response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/certificates/settings:
    get:
      tags:
      - Zones
      summary: Cloudflare List all mTLS hostname settings
      description: List all mTLS hostname settings for this zone.
      operationId: zone-level-access-mtls-authentication-list-mtls-certificates-hostname-settings
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: List mTLS hostname settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_response_collection_hostnames'
        4XX:
          description: List mTLS hostname settings response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update an mTLS certificate's hostname settings
      description: Updates an mTLS certificate's hostname settings.
      operationId: zone-level-access-mtls-authentication-update-an-mtls-certificate-settings
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - settings
              properties:
                settings:
                  type: array
                  items:
                    $ref: '#/components/schemas/access_settings'
      responses:
        '202':
          description: Update an mTLS certificates hostname settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_response_collection_hostnames'
        4XX:
          description: Update an mTLS certificates hostname settings failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates/{certificate_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Hostname Client Certificate
      operationId: per-hostname-authenticated-origin-pull-delete-hostname-client-certificate
      parameters:
      - name: certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Hostname Client Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single'
        4XX:
          description: Delete Hostname Client Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get the Hostname Client Certificate
      description: Get the certificate by ID to be used for client authentication on a hostname.
      operationId: per-hostname-authenticated-origin-pull-get-the-hostname-client-certificate
      parameters:
      - name: certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Get the Hostname Client Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single'
        4XX:
          description: Get the Hostname Client Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones:
    get:
      tags:
      - Zones
      summary: Cloudflare List Zones
      description: Lists, searches, sorts, and filters your zones.
      operationId: zones-get
      parameters:
      - name: name
        in: query
        schema:
          type: string
          description: "A domain name. Optional filter operators can be provided to extend refine the search:\n  * `equal` (default)\n  * `not_equal`\n  * `starts_with`\n  * `ends_with`\n  * `contains`\n  * `starts_with_case_sensitive`\n  * `ends_with_case_sensitive`\n  * `contains_case_sensitive`\n"
          maxLength: 253
        examples:
          Basic Query:
            summary: Simple Query
            value: example.com
          Contains Query:
            summary: Contains Query
            value: contains:.org
          Ends With Query:
            summary: Ends With Query
            value: ends_with:arpa
          Starts With Query:
            summary: Starts With Query
            value: starts_with:dev
      - name: status
        in: query
        schema:
          type: string
          description: A zone status
          enum:
          - initializing
          - pending
          - active
          - moved
      - name: account.id
        in: query
        schema:
          type: string
          description: An account ID
      - name: account.name
        in: query
        schema:
          type: string
          description: "An account Name. Optional filter operators can be provided to extend refine the search:\n  * `equal` (default)\n  * `not_equal`\n  * `starts_with`\n  * `ends_with`\n  * `contains`\n  * `starts_with_case_sensitive`\n  * `ends_with_case_sensitive`\n  * `contains_case_sensitive`\n"
          maxLength: 253
        examples:
          Basic Query:
            summary: Simple Query
            value: Dev Account
          Contains Query:
            summary: Contains Query
            value: contains:Test
      - name: page
        in: query
        schema:
          type: number
          description: Page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: Number of zones per page.
          default: 20
          minimum: 5
          maximum: 50
      - name: order
        in: query
        schema:
          type: string
          description: Field to order zones by.
          enum:
          - name
          - status
          - account.id
          - account.name
          example: status
      - name: direction
        in: query
        schema:
          type: string
          description: Direction to order zones.
          enum:
          - asc
          - desc
          example: desc
      - name: match
        in: query
        schema:
          type: string
          description: Whether to match all search requirements or at least one (any).
          enum:
          - any
          - all
          default: all
      responses:
        '200':
          description: List Zones response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_api-response-common'
                - properties:
                    result_info:
                      $ref: '#/components/schemas/zones_result_info'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/zones_zone'
        4XX:
          description: List Zones response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Zone
      operationId: zones-post
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - account
              properties:
                account:
                  type: object
                  properties:
                    id:
                      $ref: '#/components/schemas/zones_identifier'
                name:
                  $ref: '#/components/schemas/zones_name'
                type:
                  $ref: '#/components/schemas/zones_type'
      responses:
        '200':
          description: Create Zone response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_api-response-common'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/zones_zone'
        4XX:
          description: Create Zone response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{identifier}/access/apps:
    get:
      tags:
      - Zones
      summary: Cloudflare List Access Applications
      description: List all Access Applications in a zone.
      operationId: zone-level-access-applications-list-access-applications
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: List Access Applications response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_apps_components-schemas-response_collection-2'
        4XX:
          description: List Access Applications response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Add an Access application
      description: Adds a new application to Access.
      operationId: zone-level-access-applications-add-a-bookmark-application
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_schemas-apps'
      responses:
        '201':
          description: Add an Access application response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/access_apps_components-schemas-single_response-2'
                - properties:
                    result:
                      $ref: '#/components/schemas/access_schemas-apps'
        4XX:
          description: Add an Access application response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/apps/{app_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete an Access application
      description: Deletes an application from Access.
      operationId: zone-level-access-applications-delete-an-access-application
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '202':
          description: Delete an Access application response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
        4XX:
          description: Delete an Access application response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get an Access application
      description: Fetches information about an Access application.
      operationId: zone-level-access-applications-get-an-access-application
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: Get an Access application response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_apps_components-schemas-single_response-2'
        4XX:
          description: Get an Access application response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update an Access application
      description: Updates an Access application.
      operationId: zone-level-access-applications-update-a-bookmark-application
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_schemas-apps'
      responses:
        '200':
          description: Update an Access application response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/access_apps_components-schemas-single_response-2'
                - properties:
                    result:
                      $ref: '#/components/schemas/access_schemas-apps'
        4XX:
          description: Update an Access application response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/apps/{app_id}/revoke_tokens:
    post:
      tags:
      - Zones
      summary: Cloudflare Revoke application tokens
      description: Revokes all tokens issued for an application.
      operationId: zone-level-access-applications-revoke-service-tokens
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '202':
          description: Revoke application tokens response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_schemas-empty_response'
        4XX:
          description: Revoke application tokens response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/apps/{app_id}/user_policy_checks:
    get:
      tags:
      - Zones
      summary: Cloudflare Test Access policies
      description: Tests if a specific user has permission to access an application.
      operationId: zone-level-access-applications-test-access-policies
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: Test Access policies response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_policy_check_response'
        4XX:
          description: Test Access policies response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/apps/{uuid}/ca:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a short-lived certificate CA
      description: Deletes a short-lived certificate CA.
      operationId: zone-level-access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '202':
          description: Delete a short-lived certificate CA response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_schemas-id_response'
        4XX:
          description: Delete a short-lived certificate CA response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get a short-lived certificate CA
      description: Fetches a short-lived certificate CA and its public key.
      operationId: zone-level-access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: Get a short-lived certificate CA response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_ca_components-schemas-single_response'
        4XX:
          description: Get a short-lived certificate CA response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create a short-lived certificate CA
      description: Generates a new short-lived certificate CA and public key.
      operationId: zone-level-access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: Create a short-lived certificate CA response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_ca_components-schemas-single_response'
        4XX:
          description: Create a short-lived certificate CA response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/apps/{uuid}/policies:
    get:
      tags:
      - Zones
      summary: Cloudflare List Access policies
      description: Lists Access policies configured for an application.
      operationId: zone-level-access-policies-list-access-policies
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: List Access policies response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_policies_components-schemas-response_collection-2'
        4XX:
          description: List Access policies response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create an Access policy
      description: Create a new Access policy for an application.
      operationId: zone-level-access-policies-create-an-access-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - decision
              - include
              properties:
                approval_groups:
                  $ref: '#/components/schemas/access_approval_groups'
                approval_required:
                  $ref: '#/components/schemas/access_approval_required'
                decision:
                  $ref: '#/components/schemas/access_decision'
                exclude:
                  $ref: '#/components/schemas/access_schemas-exclude'
                include:
                  $ref: '#/components/schemas/access_include'
                isolation_required:
                  $ref: '#/components/schemas/access_schemas-isolation_required'
                name:
                  $ref: '#/components/schemas/access_policies_components-schemas-name'
                precedence:
                  $ref: '#/components/schemas/access_precedence'
                purpose_justification_prompt:
                  $ref: '#/components/schemas/access_purpose_justification_prompt'
                purpose_justification_required:
                  $ref: '#/components/schemas/access_purpose_justification_required'
                require:
                  $ref: '#/components/schemas/access_schemas-require'
      responses:
        '201':
          description: Create an Access policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_policies_components-schemas-single_response-2'
        4XX:
          description: Create an Access policy response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/apps/{uuid1}/policies/{uuid}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete an Access policy
      description: Delete an Access policy.
      operationId: zone-level-access-policies-delete-an-access-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: uuid1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '202':
          description: Delete an Access policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
        4XX:
          description: Delete an Access policy response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get an Access policy
      description: Fetches a single Access policy.
      operationId: zone-level-access-policies-get-an-access-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: uuid1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        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_policies_components-schemas-single_response-2'
        4XX:
          description: Get an Access policy response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update an Access policy
      description: Update a configured Access policy.
      operationId: zone-level-access-policies-update-an-access-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: uuid1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - decision
              - include
              properties:
                approval_groups:
                  $ref: '#/components/schemas/access_approval_groups'
                approval_required:
                  $ref: '#/components/schemas/access_approval_required'
                decision:
                  $ref: '#/components/schemas/access_decision'
                exclude:
                  $ref: '#/components/schemas/access_schemas-exclude'
                include:
                  $ref: '#/components/schemas/access_include'
                isolation_required:
                  $ref: '#/components/schemas/access_schemas-isolation_required'
                name:
                  $ref: '#/components/schemas/access_policies_components-schemas-name'
                precedence:
                  $ref: '#/components/schemas/access_precedence'
                purpose_justification_prompt:
                  $ref: '#/components/schemas/access_purpose_justification_prompt'
                purpose_justification_required:
                  $ref: '#/components/schemas/access_purpose_justification_required'
                require:
                  $ref: '#/components/schemas/access_schemas-require'
      responses:
        '200':
          description: Update an Access policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_policies_components-schemas-single_response-2'
        4XX:
          description: Update an Access policy response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/apps/ca:
    get:
      tags:
      - Zones
      summary: Cloudflare List short-lived certificate CAs
      description: Lists short-lived certificate CAs and their public keys.
      operationId: zone-level-access-short-lived-certificate-c-as-list-short-lived-certificate-c-as
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: List short-lived certificate CAs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_ca_components-schemas-response_collection'
        4XX:
          description: List short-lived certificate CAs response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/certificates:
    get:
      tags:
      - Zones
      summary: Cloudflare List mTLS certificates
      description: Lists all mTLS certificates.
      operationId: zone-level-access-mtls-authentication-list-mtls-certificates
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: List mTLS certificates response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-response_collection'
        4XX:
          description: List mTLS certificates response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Add an mTLS certificate
      description: Adds a new mTLS root certificate to Access.
      operationId: zone-level-access-mtls-authentication-add-an-mtls-certificate
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - certificate
              properties:
                associated_hostnames:
                  $ref: '#/components/schemas/access_associated_hostnames'
                certificate:
                  type: string
                  description: The certificate content.
                  example: '--BEGIN CERTIFICATE--

                    MIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10

                    DrUtmu/B

                    --END CERTIFICATE--'
                name:
                  $ref: '#/components/schemas/access_certificates_components-schemas-name'
      responses:
        '201':
          description: Add an mTLS certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_certificates_components-schemas-single_response'
        4XX:
          description: Add an mTLS certificate response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/groups:
    get:
      tags:
      - Zones
      summary: Cloudflare List Access groups
      description: Lists all Access groups.
      operationId: zone-level-access-groups-list-access-groups
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: List Access groups response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_groups_components-schemas-response_collection'
        4XX:
          description: List Access groups response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create an Access group
      description: Creates a new Access group.
      operationId: zone-level-access-groups-create-an-access-group
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - include
              properties:
                exclude:
                  $ref: '#/components/schemas/access_exclude'
                include:
                  $ref: '#/components/schemas/access_include'
                name:
                  $ref: '#/components/schemas/access_components-schemas-name'
                require:
                  $ref: '#/components/schemas/access_require'
      responses:
        '201':
          description: Create an Access group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_groups_components-schemas-single_response'
        4XX:
          description: Create an Access group response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/groups/{uuid}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete an Access group
      description: Deletes an Access group.
      operationId: zone-level-access-groups-delete-an-access-group
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '202':
          description: Delete an Access group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
        4XX:
          description: Delete an Access group response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get an Access group
      description: Fetches a single Access group.
      operationId: zone-level-access-groups-get-an-access-group
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: Get an Access group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_groups_components-schemas-single_response'
        4XX:
          description: Get an Access group response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update an Access group
      description: Updates a configured Access group.
      operationId: zone-level-access-groups-update-an-access-group
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - include
              properties:
                exclude:
                  $ref: '#/components/schemas/access_exclude'
                include:
                  $ref: '#/components/schemas/access_include'
                name:
                  $ref: '#/components/schemas/access_components-schemas-name'
                require:
                  $ref: '#/components/schemas/access_require'
      responses:
        '200':
          description: Update an Access group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_groups_components-schemas-single_response'
        4XX:
          description: Update an Access group response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/identity_providers:
    get:
      tags:
      - Zones
      summary: Cloudflare List Access identity providers
      description: Lists all configured identity providers.
      operationId: zone-level-access-identity-providers-list-access-identity-providers
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: List Access identity providers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_identity-providers_components-schemas-response_collection'
        4XX:
          description: List Access identity providers response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Add an Access identity provider
      description: Adds a new identity provider to Access.
      operationId: zone-level-access-identity-providers-add-an-access-identity-provider
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_schemas-identity-providers'
      responses:
        '201':
          description: Add an Access identity provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_identity-providers_components-schemas-single_response'
        4XX:
          description: Add an Access identity provider response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/identity_providers/{uuid}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete an Access identity provider
      description: Deletes an identity provider from Access.
      operationId: zone-level-access-identity-providers-delete-an-access-identity-provider
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '202':
          description: Delete an Access identity provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_id_response'
        4XX:
          description: Delete an Access identity provider response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get an Access identity provider
      description: Fetches a configured identity provider.
      operationId: zone-level-access-identity-providers-get-an-access-identity-provider
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: Get an Access identity provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_identity-providers_components-schemas-single_response'
        4XX:
          description: Get an Access identity provider response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update an Access identity provider
      description: Updates a configured identity provider.
      operationId: zone-level-access-identity-providers-update-an-access-identity-provider
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/access_schemas-identity-providers'
      responses:
        '200':
          description: Update an Access identity provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_identity-providers_components-schemas-single_response'
        4XX:
          description: Update an Access identity provider response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/organizations:
    get:
      tags:
      - Zones
      summary: Cloudflare Get your Zero Trust organization
      description: Returns the configuration for your Zero Trust organization.
      operationId: zone-level-zero-trust-organization-get-your-zero-trust-organization
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_schemas-identifier'
      responses:
        '200':
          description: Get your Zero Trust organization response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_organizations_components-schemas-single_response'
        4XX:
          description: Get your Zero Trust organization response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create your Zero Trust organization
      description: Sets up a Zero Trust organization for your account.
      operationId: zone-level-zero-trust-organization-create-your-zero-trust-organization
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - auth_domain
              properties:
                auth_domain:
                  $ref: '#/components/schemas/access_auth_domain'
                is_ui_read_only:
                  $ref: '#/components/schemas/access_is_ui_read_only'
                login_design:
                  $ref: '#/components/schemas/access_login_design'
                name:
                  $ref: '#/components/schemas/access_name'
                ui_read_only_toggle_reason:
                  $ref: '#/components/schemas/access_ui_read_only_toggle_reason'
                user_seat_expiration_inactive_time:
                  $ref: '#/components/schemas/access_user_seat_expiration_inactive_time'
      responses:
        '201':
          description: Create your Zero Trust organization response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_organizations_components-schemas-single_response'
        4XX:
          description: Create your Zero Trust organization response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update your Zero Trust organization
      description: Updates the configuration for your Zero Trust organization.
      operationId: zone-level-zero-trust-organization-update-your-zero-trust-organization
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                auth_domain:
                  $ref: '#/components/schemas/access_auth_domain'
                is_ui_read_only:
                  $ref: '#/components/schemas/access_is_ui_read_only'
                login_design:
                  $ref: '#/components/schemas/access_login_design'
                name:
                  $ref: '#/components/schemas/access_name'
                ui_read_only_toggle_reason:
                  $ref: '#/components/schemas/access_ui_read_only_toggle_reason'
                user_seat_expiration_inactive_time:
                  $ref: '#/components/schemas/access_user_seat_expiration_inactive_time'
      responses:
        '200':
          description: Update your Zero Trust organization response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_organizations_components-schemas-single_response'
        4XX:
          description: Update your Zero Trust organization response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/organizations/revoke_user:
    post:
      tags:
      - Zones
      summary: Cloudflare Revoke all Access tokens for a user
      description: Revokes a user's access across all applications.
      operationId: zone-level-zero-trust-organization-revoke-all-access-tokens-for-a-user
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - email
              properties:
                email:
                  type: string
                  description: The email of the user to revoke.
                  example: test@example.com
      responses:
        '200':
          description: Revoke all Access tokens for a user response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_empty_response'
        4xx:
          description: Revoke all Access tokens for a user response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/service_tokens:
    get:
      tags:
      - Zones
      summary: Cloudflare List service tokens
      description: Lists all service tokens.
      operationId: zone-level-access-service-tokens-list-service-tokens
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: List service tokens response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_components-schemas-response_collection'
        4XX:
          description: List service tokens response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create a service token
      description: Generates a new service token. **Note:** This is the only time you can get the Client Secret. If you lose the Client Secret, you will have to create a new service token.
      operationId: zone-level-access-service-tokens-create-a-service-token
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              properties:
                duration:
                  $ref: '#/components/schemas/access_duration'
                name:
                  $ref: '#/components/schemas/access_service-tokens_components-schemas-name'
      responses:
        '201':
          description: Create a service token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_create_response'
        4XX:
          description: Create a service token response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/access/service_tokens/{uuid}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a service token
      description: Deletes a service token.
      operationId: zone-level-access-service-tokens-delete-a-service-token
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      responses:
        '200':
          description: Delete a service token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_service-tokens_components-schemas-single_response'
        4XX:
          description: Delete a service token response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update a service token
      description: Updates a configured service token.
      operationId: zone-level-access-service-tokens-update-a-service-token
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                duration:
                  $ref: '#/components/schemas/access_duration'
                name:
                  $ref: '#/components/schemas/access_service-tokens_components-schemas-name'
      responses:
        '200':
          description: Update a service token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_service-tokens_components-schemas-single_response'
        4XX:
          description: Update a service token response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/dns_analytics/report:
    get:
      tags:
      - Zones
      summary: Cloudflare Table
      description: 'Retrieves a list of summarised aggregate metrics over a given time period.


        See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.'
      operationId: dns-analytics-table
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_identifier'
      - name: metrics
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_metrics'
      - name: dimensions
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_dimensions'
      - name: since
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_since'
      - name: until
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_until'
      - name: limit
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_limit'
      - name: sort
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_sort'
      - name: filters
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_filters'
      responses:
        '200':
          description: Table response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_dns_analytics_api_api-response-single'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/dns_dns_analytics_api_report'
        4XX:
          description: Table response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/dns_dns_analytics_api_api-response-single'
                  - type: object
                    properties:
                      result:
                        $ref: '#/components/schemas/dns_dns_analytics_api_report'
                - $ref: '#/components/schemas/dns_dns_analytics_api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/dns_analytics/report/bytime:
    get:
      tags:
      - Zones
      summary: Cloudflare By Time
      description: 'Retrieves a list of aggregate metrics grouped by time interval.


        See [Analytics API properties](https://developers.cloudflare.com/dns/reference/analytics-api-properties/) for detailed information about the available query parameters.'
      operationId: dns-analytics-by-time
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_identifier'
      - name: metrics
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_metrics'
      - name: dimensions
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_dimensions'
      - name: since
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_since'
      - name: until
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_until'
      - name: limit
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_limit'
      - name: sort
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_sort'
      - name: filters
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_filters'
      - name: time_delta
        in: query
        schema:
          $ref: '#/components/schemas/dns_dns_analytics_api_time_delta'
      responses:
        '200':
          description: By Time response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_dns_analytics_api_api-response-single'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/dns_dns_analytics_api_report_bytime'
        4XX:
          description: By Time response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/dns_dns_analytics_api_api-response-single'
                  - type: object
                    properties:
                      result:
                        $ref: '#/components/schemas/dns_dns_analytics_api_report_bytime'
                - $ref: '#/components/schemas/dns_dns_analytics_api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{identifier}/subscription:
    get:
      tags:
      - Zones
      summary: Cloudflare Zone Subscription Details
      description: Lists zone subscription details.
      operationId: zone-subscription-zone-subscription-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
      responses:
        '200':
          description: Zone Subscription Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single'
        4XX:
          description: Zone Subscription Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single'
                - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Zone Subscription
      description: Create a zone subscription, either plan or add-ons.
      operationId: zone-subscription-create-zone-subscription
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bill-subs-api_subscription-v2'
      responses:
        '200':
          description: Create Zone Subscription response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single'
        4XX:
          description: Create Zone Subscription response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single'
                - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Zone Subscription
      description: Updates zone subscriptions, either plan or add-ons.
      operationId: zone-subscription-update-zone-subscription
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bill-subs-api_subscription-v2'
      responses:
        '200':
          description: Update Zone Subscription response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single'
        4XX:
          description: Update Zone Subscription response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bill-subs-api_zone_subscription_response_single'
                - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Zone
      description: Deletes an existing zone.
      operationId: zones-0-delete
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-single-id'
        4XX:
          description: Delete Zone response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Zone Details
      operationId: zones-0-get
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Zone Details response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_api-response-common'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/zones_zone'
        4XX:
          description: Zone Details response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Edit Zone
      description: Edits a zone. Only one zone property can be changed at a time.
      operationId: zones-0-patch
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              example:
                paused: true
              properties:
                paused:
                  $ref: '#/components/schemas/zones_paused'
                plan:
                  type: object
                  description: '(Deprecated) Please use the `/zones/{zone_id}/subscription` API

                    to update a zone''s plan. Changing this value will create/cancel

                    associated subscriptions. To view available plans for this zone,

                    see Zone Plans.

                    '
                  properties:
                    id:
                      $ref: '#/components/schemas/zones_identifier'
                type:
                  type: string
                  description: 'A full zone implies that DNS is hosted with Cloudflare. A partial

                    zone is typically a partner-hosted zone or a CNAME setup. This

                    parameter is only available to Enterprise customers or if it has

                    been explicitly enabled on a zone.

                    '
                  enum:
                  - full
                  - partial
                  - secondary
                  example: full
                vanity_name_servers:
                  $ref: '#/components/schemas/zones_vanity_name_servers'
      responses:
        '200':
          description: Edit Zone response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_api-response-common'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/zones_zone'
        4XX:
          description: Edit Zone response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/acm/total_tls:
    get:
      tags:
      - Zones
      summary: Cloudflare Total TLS Settings Details
      description: Get Total TLS Settings for a Zone.
      operationId: total-tls-total-tls-settings-details
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Total TLS Settings Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_total_tls_settings_response'
        4XX:
          description: Total TLS Settings Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_total_tls_settings_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Enable or Disable Total TLS
      description: Set Total TLS Settings or disable the feature for a Zone.
      operationId: total-tls-enable-or-disable-total-tls
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - enabled
              properties:
                certificate_authority:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_authority'
                enabled:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-enabled'
      responses:
        '200':
          description: Enable or Disable Total TLS response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_total_tls_settings_response'
        4XX:
          description: Enable or Disable Total TLS response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_total_tls_settings_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/activation_check:
    put:
      tags:
      - Zones
      summary: Cloudflare Rerun the Activation Check
      description: 'Triggeres a new activation check for a PENDING Zone. This can be

        triggered every 5 min for paygo/ent customers, every hour for FREE

        Zones.'
      operationId: put-zones-zone_id-activation_check
      parameters:
      - name: zone_id
        in: path
        description: Zone ID
        required: true
        schema:
          $ref: '#/components/schemas/zone-activation_identifier'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone-activation_api-response-single'
                - type: object
                  properties:
                    result:
                      type: object
                      properties:
                        id:
                          $ref: '#/components/schemas/zone-activation_identifier'
        4XX:
          description: Client Error
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone-activation_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/analytics/latency:
    get:
      tags:
      - Zones
      summary: Cloudflare Argo Analytics for a zone
      operationId: argo-analytics-for-zone-argo-analytics-for-a-zone
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/argo-analytics_identifier'
      - name: bins
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Argo Analytics for a zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/argo-analytics_response_single'
        4XX:
          description: Argo Analytics for a zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/argo-analytics_response_single'
                - $ref: '#/components/schemas/argo-analytics_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/analytics/latency/colos:
    get:
      tags:
      - Zones
      summary: Cloudflare Argo Analytics for a zone at different PoPs
      operationId: argo-analytics-for-geolocation-argo-analytics-for-a-zone-at-different-po-ps
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/argo-analytics_identifier'
      responses:
        '200':
          description: Argo Analytics for a zone at different PoPs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/argo-analytics_response_single'
        4XX:
          description: Argo Analytics for a zone at different PoPs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/argo-analytics_response_single'
                - $ref: '#/components/schemas/argo-analytics_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/api_gateway/configuration:
    get:
      tags:
      - Zones
      summary: Cloudflare Retrieve information about specific configuration properties
      operationId: api-shield-settings-retrieve-information-about-specific-configuration-properties
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - name: properties
        in: query
        schema:
          $ref: '#/components/schemas/api-shield_properties'
      responses:
        '200':
          description: Retrieve information about specific configuration properties response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_single_response'
        4XX:
          description: Retrieve information about specific configuration properties response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_single_response'
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Set configuration properties
      operationId: api-shield-settings-set-configuration-properties
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api-shield_configuration'
      responses:
        '200':
          description: Set configuration properties response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_default_response'
        4XX:
          description: Set configuration properties response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_default_response'
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/api_gateway/discovery:
    get:
      tags:
      - Zones
      summary: Cloudflare Retrieve discovered operations on a zone rendered as OpenAPI schemas
      description: Retrieve the most up to date view of discovered operations, rendered as OpenAPI schemas
      operationId: api-shield-api-discovery-retrieve-discovered-operations-on-a-zone-as-openapi
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      responses:
        '200':
          description: Retrieve discovered operations on a zone, rendered as OpenAPI schemas response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_schema_response_discovery'
        4XX:
          description: Retrieve discovered operations on a zone, rendered as OpenAPI schemas response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_schema_response_discovery'
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/api_gateway/discovery/operations:
    get:
      tags:
      - Zones
      summary: Cloudflare Retrieve discovered operations on a zone
      description: Retrieve the most up to date view of discovered operations
      operationId: api-shield-api-discovery-retrieve-discovered-operations-on-a-zone
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - $ref: '#/components/parameters/api-shield_page'
      - $ref: '#/components/parameters/api-shield_per_page'
      - $ref: '#/components/parameters/api-shield_host_parameter'
      - $ref: '#/components/parameters/api-shield_method_parameter'
      - $ref: '#/components/parameters/api-shield_endpoint_parameter'
      - $ref: '#/components/parameters/api-shield_direction_parameter'
      - $ref: '#/components/parameters/api-shield_order_parameter'
      - $ref: '#/components/parameters/api-shield_diff_parameter'
      - $ref: '#/components/parameters/api-shield_api_discovery_origin_parameter'
      - $ref: '#/components/parameters/api-shield_api_discovery_state_parameter'
      responses:
        '200':
          description: Retrieve discovered operations on a zone response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-collection'
                - properties:
                    result:
                      type: array
                      items:
                        anyOf:
                        - $ref: '#/components/schemas/api-shield_discovery_operation'
        4XX:
          description: Retrieve discovered operations on a zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Patch discovered operations
      description: Update the `state` on one or more discovered operations
      operationId: api-shield-api-patch-discovered-operations
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api-shield_api_discovery_patch_multiple_request'
      responses:
        '200':
          description: Patch discovered operations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_patch_discoveries_response'
        4XX:
          description: Patch discovered operations response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/api_gateway/discovery/operations/{operation_id}:
    patch:
      tags:
      - Zones
      summary: Cloudflare Patch discovered operation
      description: Update the `state` on a discovered operation
      operationId: api-shield-api-patch-discovered-operation
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - $ref: '#/components/parameters/api-shield_parameters-operation_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                state:
                  allOf:
                  - $ref: '#/components/schemas/api-shield_api_discovery_state_patch'
      responses:
        '200':
          description: Patch discovered operation response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_patch_discovery_response'
        4XX:
          description: Patch discovered operation response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/api_gateway/operations:
    get:
      tags:
      - Zones
      summary: Cloudflare Retrieve information about all operations on a zone
      operationId: api-shield-endpoint-management-retrieve-information-about-all-operations-on-a-zone
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - $ref: '#/components/parameters/api-shield_page'
      - name: per_page
        in: query
        description: Number of results to return per page
        schema:
          type: number
          default: 20
          minimum: 5
      - name: order
        in: query
        schema:
          type: string
          description: Field to order by. When requesting a feature, the feature keys are available for ordering as well, e.g., `thresholds.suggested_threshold`.
          enum:
          - method
          - host
          - endpoint
          - thresholds.$key
          example: method
      - $ref: '#/components/parameters/api-shield_direction_parameter'
      - $ref: '#/components/parameters/api-shield_host_parameter'
      - $ref: '#/components/parameters/api-shield_method_parameter'
      - $ref: '#/components/parameters/api-shield_endpoint_parameter'
      - $ref: '#/components/parameters/api-shield_operation_feature_parameter'
      responses:
        '200':
          description: Retrieve information about all operations on a zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_collection_response_paginated'
        4XX:
          description: Retrieve information about all operations on a zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Add operations to a zone
      description: Add one or more operations to a zone. Endpoints can contain path variables. Host, method, endpoint will be normalized to a canoncial form when creating an operation and must be unique on the zone. Inserting an operation that matches an existing one will return the record of the already existing operation and update its last_updated date.
      operationId: api-shield-endpoint-management-add-operations-to-a-zone
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/api-shield_basic_operation'
      responses:
        '200':
          description: Add operations to a zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_collection_response'
        4XX:
          description: Add operations to a zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_collection_response'
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/api_gateway/operations/{operation_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete an operation
      operationId: api-shield-endpoint-management-delete-an-operation
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - $ref: '#/components/parameters/api-shield_operation_id'
      responses:
        '200':
          description: Delete an operation response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_default_response'
        4XX:
          description: Delete an operation response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_default_response'
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    get:
      tags:
      - Zones
      summary: Cloudflare Retrieve information about an operation
      operationId: api-shield-endpoint-management-retrieve-information-about-an-operation
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - $ref: '#/components/parameters/api-shield_operation_id'
      - $ref: '#/components/parameters/api-shield_operation_feature_parameter'
      responses:
        '200':
          description: Retrieve information about an operation response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_schemas-single_response'
        4XX:
          description: Retrieve information about an operation response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_schemas-single_response'
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/api_gateway/operations/{operation_id}/schema_validation:
    get:
      tags:
      - Zones
      summary: Cloudflare Retrieve operation-level schema validation settings
      description: Retrieves operation-level schema validation settings on the zone
      operationId: api-shield-schema-validation-retrieve-operation-level-settings
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - $ref: '#/components/parameters/api-shield_operation_id'
      responses:
        '200':
          description: Operation-level schema validation settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_operation_schema_validation_settings'
        4XX:
          description: Operation-level schema validation settings response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update operation-level schema validation settings
      description: Updates operation-level schema validation settings on the zone
      operationId: api-shield-schema-validation-update-operation-level-settings
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - $ref: '#/components/parameters/api-shield_operation_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api-shield_operation_schema_validation_settings'
      responses:
        '200':
          description: Update operation-level schema validation settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_operation_schema_validation_settings'
        4XX:
          description: Update operation-level schema validation settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/api_gateway/operations/schema_validation:
    patch:
      tags:
      - Zones
      summary: Cloudflare Update multiple operation-level schema validation settings
      description: Updates multiple operation-level schema validation settings on the zone
      operationId: api-shield-schema-validation-update-multiple-operation-level-settings
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api-shield_operation_schema_validation_settings_multiple_request'
      responses:
        '200':
          description: Update multiple operation-level schema validation settings response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/api-shield_operation_schema_validation_settings_multiple_request'
        4XX:
          description: Update multiple operation-level schema validation settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/api_gateway/schemas:
    get:
      tags:
      - Zones
      summary: Cloudflare Retrieve operations and features as OpenAPI schemas
      operationId: api-shield-endpoint-management-retrieve-operations-and-features-as-open-api-schemas
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - name: host
        in: query
        schema:
          type: array
          description: Receive schema only for the given host(s).
          uniqueItems: true
          items:
            type: string
            example: www.example.com
      - $ref: '#/components/parameters/api-shield_operation_feature_parameter'
      responses:
        '200':
          description: Retrieve operations and features as OpenAPI schemas response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_schema_response_with_thresholds'
        4XX:
          description: Retrieve operations and features as OpenAPI schemas response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_schema_response_with_thresholds'
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/api_gateway/settings/schema_validation:
    get:
      tags:
      - Zones
      summary: Cloudflare Retrieve zone level schema validation settings
      description: Retrieves zone level schema validation settings currently set on the zone
      operationId: api-shield-schema-validation-retrieve-zone-level-settings
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      responses:
        '200':
          description: Zone level schema validation settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_zone_schema_validation_settings'
        4XX:
          description: Zone level schema validation settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Update zone level schema validation settings
      description: Updates zone level schema validation settings on the zone
      operationId: api-shield-schema-validation-patch-zone-level-settings
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api-shield_zone_schema_validation_settings_patch'
      responses:
        '200':
          description: Update zone level schema validation settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_zone_schema_validation_settings'
        4XX:
          description: Update zone level schema validation settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update zone level schema validation settings
      description: Updates zone level schema validation settings on the zone
      operationId: api-shield-schema-validation-update-zone-level-settings
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/api-shield_zone_schema_validation_settings_put'
      responses:
        '200':
          description: Update zone level schema validation settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_zone_schema_validation_settings'
        4XX:
          description: Update zone level schema validation settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/api_gateway/user_schemas:
    get:
      tags:
      - Zones
      summary: Cloudflare Retrieve information about all schemas on a zone
      operationId: api-shield-schema-validation-retrieve-information-about-all-schemas
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - $ref: '#/components/parameters/api-shield_page'
      - $ref: '#/components/parameters/api-shield_per_page'
      - $ref: '#/components/parameters/api-shield_omit_source'
      - name: validation_enabled
        in: query
        schema:
          $ref: '#/components/schemas/api-shield_validation_enabled'
      responses:
        '200':
          description: Retrieve information about all schemas on a zone response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-collection'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/api-shield_public_schema'
        4XX:
          description: Retrieve information about all schemas on a zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Upload a schema to a zone
      operationId: api-shield-schema-validation-post-schema
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - file
              - kind
              properties:
                file:
                  type: string
                  format: binary
                  description: Schema file bytes
                kind:
                  $ref: '#/components/schemas/api-shield_kind'
                name:
                  type: string
                  description: Name of the schema
                  example: petstore schema
                validation_enabled:
                  type: string
                  description: Flag whether schema is enabled for validation.
                  enum:
                  - 'true'
                  - 'false'
      responses:
        '200':
          description: Upload a schema response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/api-shield_schema_upload_response'
        4XX:
          description: Upload a schema response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_schema_upload_failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/api_gateway/user_schemas/{schema_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a schema
      operationId: api-shield-schema-delete-a-schema
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - $ref: '#/components/parameters/api-shield_schema_id'
      responses:
        '200':
          description: Delete a schema response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_api-response-single'
        4XX:
          description: Delete a schema response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    get:
      tags:
      - Zones
      summary: Cloudflare Retrieve information about a specific schema on a zone
      operationId: api-shield-schema-validation-retrieve-information-about-specific-schema
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - $ref: '#/components/parameters/api-shield_schema_id'
      - $ref: '#/components/parameters/api-shield_omit_source'
      responses:
        '200':
          description: Retrieve information about a specific schema on a zone response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/api-shield_public_schema'
        4XX:
          description: Retrieve information about a specific schema zone response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Enable validation for a schema
      operationId: api-shield-schema-validation-enable-validation-for-a-schema
      parameters:
      - $ref: '#/components/parameters/api-shield_zone_id'
      - $ref: '#/components/parameters/api-shield_schema_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                validation_enabled:
                  allOf:
                  - $ref: '#/components/schemas/api-shield_validation_enabled'
                  - enum:
                    - true
      responses:
        '200':
          description: Enable validation for a schema response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/api-shield_public_schema'
        4XX:
          description: Enable validation for a schema response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/api_gateway/user_schemas/{schema_id}/operations:
    get:
      tags:
      - Zones
      summary: Cloudflare Retrieve all operations from a schema.
      description: Retrieves all operations from the schema. Operations that already exist in API Shield Endpoint Management will be returned as full operations.
      operationId: api-shield-schema-validation-extract-operations-from-schema
      parameters:
      - $ref: '#/components/parameters/api-shield_schema_id'
      - $ref: '#/components/parameters/api-shield_zone_id'
      - $ref: '#/components/parameters/api-shield_operation_feature_parameter'
      - $ref: '#/components/parameters/api-shield_host_parameter'
      - $ref: '#/components/parameters/api-shield_method_parameter'
      - $ref: '#/components/parameters/api-shield_endpoint_parameter'
      - $ref: '#/components/parameters/api-shield_page'
      - $ref: '#/components/parameters/api-shield_per_page'
      - name: operation_status
        in: query
        description: Filter results by whether operations exist in API Shield Endpoint Management or not. `new` will just return operations from the schema that do not exist in API Shield Endpoint Management. `existing` will just return operations from the schema that already exist in API Shield Endpoint Management.
        schema:
          type: string
          enum:
          - new
          - existing
          example: new
      responses:
        '200':
          description: Retrieve all operations from a schema response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-shield_api-response-collection'
                - properties:
                    result:
                      type: array
                      items:
                        anyOf:
                        - $ref: '#/components/schemas/api-shield_operation'
                        - $ref: '#/components/schemas/api-shield_basic_operation'
        4XX:
          description: Retrieve all operations from a schema response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/argo/smart_routing:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Argo Smart Routing setting
      operationId: argo-smart-routing-get-argo-smart-routing-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/argo-config_identifier'
      responses:
        '200':
          description: Get Argo Smart Routing setting response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/argo-config_response_single'
        4XX:
          description: Get Argo Smart Routing setting response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/argo-config_response_single'
                - $ref: '#/components/schemas/argo-config_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Patch Argo Smart Routing setting
      description: Updates enablement of Argo Smart Routing.
      operationId: argo-smart-routing-patch-argo-smart-routing-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/argo-config_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/argo-config_patch'
      responses:
        '200':
          description: Patch Argo Smart Routing setting response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/argo-config_response_single'
        4XX:
          description: Patch Argo Smart Routing setting response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/argo-config_response_single'
                - $ref: '#/components/schemas/argo-config_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/argo/tiered_caching:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Tiered Caching setting
      operationId: tiered-caching-get-tiered-caching-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      responses:
        '200':
          description: Get Tiered Caching setting response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cache_response_single'
        4XX:
          description: Get Tiered Caching setting response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_response_single'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Patch Tiered Caching setting
      description: Updates enablement of Tiered Caching
      operationId: tiered-caching-patch-tiered-caching-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cache_patch'
      responses:
        '200':
          description: Patch Tiered Caching setting response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cache_response_single'
        4XX:
          description: Patch Tiered Caching setting response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_response_single'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/bot_management:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Zone Bot Management Config
      description: Retrieve a zone's Bot Management Config
      operationId: bot-management-for-a-zone-get-config
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bot-management_identifier'
      responses:
        '200':
          description: Bot Management config response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bot-management_bot_management_response_body'
        4XX:
          description: Bot Management config response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bot-management_bot_management_response_body'
                - $ref: '#/components/schemas/bot-management_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Zone Bot Management Config
      description: 'Updates the Bot Management configuration for a zone.


        This API is used to update:

        - **Bot Fight Mode**

        - **Super Bot Fight Mode**

        - **Bot Management for Enterprise**


        See [Bot Plans](https://developers.cloudflare.com/bots/plans/) for more information on the different plans

        '
      operationId: bot-management-for-a-zone-update-config
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bot-management_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bot-management_config_single'
      responses:
        '200':
          description: Update Bot Management response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bot-management_bot_management_response_body'
        4XX:
          description: Update Bot Management response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bot-management_bot_management_response_body'
                - $ref: '#/components/schemas/bot-management_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/cache/cache_reserve:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Cache Reserve setting
      description: 'Increase cache lifetimes by automatically storing all cacheable files into Cloudflare''s persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.'
      operationId: zone-cache-settings-get-cache-reserve-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      responses:
        '200':
          description: Get Cache Reserve setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_cache_reserve_response_value'
              examples:
                'off':
                  $ref: '#/components/examples/cache_cache_reserve_off'
        4XX:
          description: Get Cache Reserve setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/cache_cache_reserve_response_value'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
              examples:
                Error:
                  $ref: '#/components/examples/cache_dummy_error_response'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Cache Reserve setting
      description: 'Increase cache lifetimes by automatically storing all cacheable files into Cloudflare''s persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.'
      operationId: zone-cache-settings-change-cache-reserve-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/cache_cache_reserve_value'
      responses:
        '200':
          description: Change Cache Reserve setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_cache_reserve_response_value'
              examples:
                'off':
                  $ref: '#/components/examples/cache_cache_reserve_off'
        4XX:
          description: Change Cache Reserve setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/cache_cache_reserve_response_value'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
              examples:
                Denied:
                  $ref: '#/components/examples/cache_cache_reserve_denied_clearing'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/cache/cache_reserve_clear:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Cache Reserve Clear
      description: You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.
      operationId: zone-cache-settings-get-cache-reserve-clear
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      responses:
        '200':
          description: Get Cache Reserve Clear response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_cache_reserve_clear_response_value'
              examples:
                Completed:
                  $ref: '#/components/examples/cache_cache_reserve_clear_completed'
                In-progress:
                  $ref: '#/components/examples/cache_cache_reserve_clear_in_progress'
        4XX:
          description: Get Cache Reserve Clear failure response
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/cache_cache_reserve_clear_response_value'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
              examples:
                Not found:
                  $ref: '#/components/examples/cache_cache_reserve_clear_not_found'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Start Cache Reserve Clear
      description: You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.
      operationId: zone-cache-settings-start-cache-reserve-clear
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      requestBody:
        description: The request body is currently not used.
        required: true
        content:
          application/json:
            example: '{}'
      responses:
        '200':
          description: Start Cache Reserve Clear response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_cache_reserve_clear_response_value'
              examples:
                In-progress:
                  $ref: '#/components/examples/cache_cache_reserve_clear_in_progress'
        4XX:
          description: Start Cache Reserve Clear failure response
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/cache_cache_reserve_clear_response_value'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
              examples:
                Rejected:
                  $ref: '#/components/examples/cache_cache_reserve_clear_rejected_cr_on'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/cache/origin_post_quantum_encryption:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Origin Post-Quantum Encryption setting
      description: Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised
      operationId: zone-cache-settings-get-origin-post-quantum-encryption-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      responses:
        '200':
          description: Get Origin Post-Quantum Encryption setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_origin_post_quantum_encryption_value'
        4XX:
          description: Get Origin Post-Quantum Encryption setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_origin_post_quantum_encryption_value'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Change Origin Post-Quantum Encryption setting
      description: Instructs Cloudflare to use Post-Quantum (PQ) key agreement algorithms when connecting to your origin. Preferred instructs Cloudflare to opportunistically send a Post-Quantum keyshare in the first message to the origin (for fastest connections when the origin supports and prefers PQ), supported means that PQ algorithms are advertised but only used when requested by the origin, and off means that PQ algorithms are not advertised
      operationId: zone-cache-settings-change-origin-post-quantum-encryption-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/cache_origin_post_quantum_encryption_value'
      responses:
        '200':
          description: Change Origin Post-Quantum Encryption setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_origin_post_quantum_encryption_value'
        4XX:
          description: Change Origin Post-Quantum Encryption setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_origin_post_quantum_encryption_value'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/cache/regional_tiered_cache:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Regional Tiered Cache setting
      description: Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.
      operationId: zone-cache-settings-get-regional-tiered-cache-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      responses:
        '200':
          description: Get Regional Tiered Cache setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_regional_tiered_cache_response_value'
        4XX:
          description: Get Regional Tiered Cache setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/cache_regional_tiered_cache_response_value'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Regional Tiered Cache setting
      description: Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.
      operationId: zone-cache-settings-change-regional-tiered-cache-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/cache_regional_tiered_cache_value'
      responses:
        '200':
          description: Change Regional Tiered Cache setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_regional_tiered_cache_response_value'
        4XX:
          description: Change Regional Tiered Cache setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/cache_regional_tiered_cache_response_value'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/cache/tiered_cache_smart_topology_enable:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Smart Tiered Cache setting
      description: Remvoves enablement of Smart Tiered Cache
      operationId: smart-tiered-cache-delete-smart-tiered-cache-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Smart Tiered Cache setting response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cache_response_single'
        4XX:
          description: Delete Smart Tiered Cache setting response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_response_single'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get Smart Tiered Cache setting
      operationId: smart-tiered-cache-get-smart-tiered-cache-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      responses:
        '200':
          description: Get Smart Tiered Cache setting response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cache_response_single'
        4XX:
          description: Get Smart Tiered Cache setting response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_response_single'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Patch Smart Tiered Cache setting
      description: Updates enablement of Tiered Cache
      operationId: smart-tiered-cache-patch-smart-tiered-cache-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/cache_schemas-patch'
      responses:
        '200':
          description: Patch Smart Tiered Cache setting response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cache_response_single'
        4XX:
          description: Patch Smart Tiered Cache setting response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_response_single'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/cache/variants:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete variants setting
      description: 'Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ''Vary: Accept'' response header. If the origin server sends ''Vary: Accept'' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.'
      operationId: zone-cache-settings-delete-variants-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete variants setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/cache_variants'
        4XX:
          description: Delete variants setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cache_variants'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get variants setting
      description: 'Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ''Vary: Accept'' response header. If the origin server sends ''Vary: Accept'' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.'
      operationId: zone-cache-settings-get-variants-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      responses:
        '200':
          description: Get variants setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_variants_response_value'
        4XX:
          description: Get variants setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/cache_variants_response_value'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change variants setting
      description: 'Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ''Vary: Accept'' response header. If the origin server sends ''Vary: Accept'' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.'
      operationId: zone-cache-settings-change-variants-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/cache_variants_value'
      responses:
        '200':
          description: Change variants setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_variants_response_value'
        4XX:
          description: Change variants setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/cache_variants_response_value'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/certificate_authorities/hostname_associations:
    get:
      tags:
      - Zones
      summary: Cloudflare List Hostname Associations
      description: List Hostname Associations
      operationId: client-certificate-for-a-zone-list-hostname-associations
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: mtls_certificate_id
        in: query
        schema:
          type: string
          description: The UUID to match against for a certificate that was uploaded to the mTLS Certificate Management endpoint. If no mtls_certificate_id is given, the results will be the hostnames associated to your active Cloudflare Managed CA.
          example: b2134436-2555-4acf-be5b-26c48136575e
          minLength: 36
          maxLength: 36
      responses:
        '200':
          description: List Hostname Associations Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_associations_response'
        4XX:
          description: List Hostname Associations Response Failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Replace Hostname Associations
      description: Replace Hostname Associations
      operationId: client-certificate-for-a-zone-put-hostname-associations
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_association'
      responses:
        '200':
          description: Replace Hostname Associations Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_associations_response'
        4XX:
          description: Replace Hostname Associations Response Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/client_certificates:
    get:
      tags:
      - Zones
      summary: Cloudflare List Client Certificates
      description: List all of your Zone's API Shield mTLS Client Certificates by Status and/or using Pagination
      operationId: client-certificate-for-a-zone-list-client-certificates
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: status
        in: query
        schema:
          description: Client Certitifcate Status to filter results by.
          enum:
          - all
          - active
          - pending_reactivation
          - pending_revocation
          - revoked
          example: all
      - name: page
        in: query
        schema:
          type: number
          description: Page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: Number of records per page.
          default: 20
          minimum: 5
          maximum: 50
      - name: limit
        in: query
        schema:
          type: integer
          description: Limit to the number of records returned.
          example: 10
      - name: offset
        in: query
        schema:
          type: integer
          description: Offset the results
          example: 10
      responses:
        '200':
          description: List Client Certificates Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_collection'
        4XX:
          description: List Client Certificates Response Failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Client Certificate
      description: Create a new API Shield mTLS Client Certificate
      operationId: client-certificate-for-a-zone-create-client-certificate
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - csr
              - validity_days
              properties:
                csr:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-csr'
                validity_days:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-validity_days'
      responses:
        '200':
          description: Create Client Certificate Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single'
        4XX:
          description: Create Client Certificate Response Failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/client_certificates/{client_certificate_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Revoke Client Certificate
      description: Set a API Shield mTLS Client Certificate to pending_revocation status for processing to revoked status.
      operationId: client-certificate-for-a-zone-delete-client-certificate
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: client_certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Revoke Client Certificate Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single'
        4XX:
          description: Revoke Client Certificate Response Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Client Certificate Details
      description: Get Details for a single mTLS API Shield Client Certificate
      operationId: client-certificate-for-a-zone-client-certificate-details
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: client_certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Client Certificate Details Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single'
        4XX:
          description: Client Certificate Details Response Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Reactivate Client Certificate
      description: If a API Shield mTLS Client Certificate is in a pending_revocation state, you may reactivate it with this endpoint.
      operationId: client-certificate-for-a-zone-edit-client-certificate
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: client_certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Reactivate Client Certificate Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate_response_single'
        4XX:
          description: Reactivate Client Certificate Response Failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/custom_certificates:
    get:
      tags:
      - Zones
      summary: Cloudflare List SSL Configurations
      description: List, search, and filter all of your custom SSL certificates. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.
      operationId: custom-ssl-for-a-zone-list-ssl-configurations
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: page
        in: query
        schema:
          type: number
          description: Page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: Number of zones per page.
          default: 20
          minimum: 5
          maximum: 50
      - name: match
        in: query
        schema:
          type: string
          description: Whether to match all search requirements or at least one (any).
          enum:
          - any
          - all
          default: all
      - name: status
        in: query
        schema:
          description: Status of the zone's custom SSL.
          enum:
          - active
          - expired
          - deleted
          - pending
          - initializing
          example: active
          readOnly: true
      responses:
        '200':
          description: List SSL Configurations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_collection'
        4XX:
          description: List SSL Configurations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_collection'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create SSL Configuration
      description: Upload a new SSL certificate for a zone.
      operationId: custom-ssl-for-a-zone-create-ssl-configuration
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - certificate
              - private_key
              properties:
                bundle_method:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_bundle_method'
                certificate:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate'
                geo_restrictions:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_geo_restrictions'
                policy:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_policy'
                private_key:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_private_key'
                type:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_type'
      responses:
        '200':
          description: Create SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single'
        4XX:
          description: Create SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/custom_certificates/{custom_certificate_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete SSL Configuration
      description: Remove a SSL certificate from a zone.
      operationId: custom-ssl-for-a-zone-delete-ssl-configuration
      parameters:
      - name: custom_certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_id_only'
        4XX:
          description: Delete SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_id_only'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare SSL Configuration Details
      operationId: custom-ssl-for-a-zone-ssl-configuration-details
      parameters:
      - name: custom_certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: SSL Configuration Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single'
        4XX:
          description: SSL Configuration Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Edit SSL Configuration
      description: 'Upload a new private key and/or PEM/CRT for the SSL certificate. Note: PATCHing a configuration for sni_custom certificates will result in a new resource id being returned, and the previous one being deleted.'
      operationId: custom-ssl-for-a-zone-edit-ssl-configuration
      parameters:
      - name: custom_certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                bundle_method:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_bundle_method'
                certificate:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate'
                geo_restrictions:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_geo_restrictions'
                policy:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_policy'
                private_key:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_private_key'
      responses:
        '200':
          description: Edit SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single'
        4XX:
          description: Edit SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/custom_certificates/prioritize:
    put:
      tags:
      - Zones
      summary: Cloudflare Re-prioritize SSL Certificates
      description: If a zone has multiple SSL certificates, you can set the order in which they should be used during a request. The higher priority will break ties across overlapping 'legacy_custom' certificates.
      operationId: custom-ssl-for-a-zone-re-prioritize-ssl-certificates
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - certificates
              properties:
                certificates:
                  type: array
                  description: Array of ordered certificates.
                  example:
                  - id: 5a7805061c76ada191ed06f989cc3dac
                    priority: 2
                  - id: 9a7806061c88ada191ed06f989cc3dac
                    priority: 1
                  items:
                    type: object
                    properties:
                      id:
                        $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
                      priority:
                        $ref: '#/components/schemas/tls-certificates-and-hostnames_priority'
      responses:
        '200':
          description: Re-prioritize SSL Certificates response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_collection'
        4XX:
          description: Re-prioritize SSL Certificates response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_collection'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/custom_hostnames:
    get:
      tags:
      - Zones
      summary: Cloudflare List Custom Hostnames
      description: List, search, sort, and filter all of your custom hostnames.
      operationId: custom-hostname-for-a-zone-list-custom-hostnames
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: hostname
        in: query
        schema:
          type: string
          description: Fully qualified domain name to match against. This parameter cannot be used with the 'id' parameter.
          example: app.example.com
          maxLength: 255
      - name: id
        in: query
        schema:
          type: string
          description: Hostname ID to match against. This ID was generated and returned during the initial custom_hostname creation. This parameter cannot be used with the 'hostname' parameter.
          example: 0d89c70d-ad9f-4843-b99f-6cc0252067e9
          minLength: 36
          maxLength: 36
      - name: page
        in: query
        schema:
          type: number
          description: Page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: Number of hostnames per page.
          default: 20
          minimum: 5
          maximum: 50
      - name: order
        in: query
        schema:
          description: Field to order hostnames by.
          enum:
          - ssl
          - ssl_status
          default: ssl
          example: ssl
      - name: direction
        in: query
        schema:
          description: Direction to order hostnames.
          enum:
          - asc
          - desc
          example: desc
      - name: ssl
        in: query
        schema:
          description: Whether to filter hostnames based on if they have SSL enabled.
          enum:
          - 0
          - 1
          default: '0'
      responses:
        '200':
          description: List Custom Hostnames response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_collection'
        4XX:
          description: List Custom Hostnames response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_collection'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Custom Hostname
      description: Add a new custom hostname and request that an SSL certificate be issued for it. One of three validation methods—http, txt, email—should be used, with 'http' recommended if the CNAME is already in place (or will be soon). Specifying 'email' will send an email to the WHOIS contacts on file for the base domain plus hostmaster, postmaster, webmaster, admin, administrator. If http is used and the domain is not already pointing to the Managed CNAME host, the PATCH method must be used once it is (to complete validation).
      operationId: custom-hostname-for-a-zone-create-custom-hostname
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - hostname
              - ssl
              properties:
                custom_metadata:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_metadata'
                hostname:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_post'
                ssl:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_sslpost'
      responses:
        '200':
          description: Create Custom Hostname response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single'
        4XX:
          description: Create Custom Hostname response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/custom_hostnames/{custom_hostname_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Custom Hostname (and any issued SSL certificates)
      operationId: custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates)
      parameters:
      - name: custom_hostname_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Custom Hostname (and any issued SSL certificates) response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        4XX:
          description: Delete Custom Hostname (and any issued SSL certificates) response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    id:
                      $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Custom Hostname Details
      operationId: custom-hostname-for-a-zone-custom-hostname-details
      parameters:
      - name: custom_hostname_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Custom Hostname Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single'
        4XX:
          description: Custom Hostname Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Edit Custom Hostname
      description: Modify SSL configuration for a custom hostname. When sent with SSL config that matches existing config, used to indicate that hostname should pass domain control validation (DCV). Can also be used to change validation type, e.g., from 'http' to 'email'.
      operationId: custom-hostname-for-a-zone-edit-custom-hostname
      parameters:
      - name: custom_hostname_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                custom_metadata:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_metadata'
                custom_origin_server:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_server'
                custom_origin_sni:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_sni'
                ssl:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_sslpost'
      responses:
        '200':
          description: Edit Custom Hostname response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single'
        4XX:
          description: Edit Custom Hostname response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_hostname_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/custom_hostnames/fallback_origin:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Fallback Origin for Custom Hostnames
      operationId: custom-hostname-fallback-origin-for-a-zone-delete-fallback-origin-for-custom-hostnames
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Fallback Origin for Custom Hostnames response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response'
        4XX:
          description: Delete Fallback Origin for Custom Hostnames response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get Fallback Origin for Custom Hostnames
      operationId: custom-hostname-fallback-origin-for-a-zone-get-fallback-origin-for-custom-hostnames
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Get Fallback Origin for Custom Hostnames response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response'
        4XX:
          description: Get Fallback Origin for Custom Hostnames response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Fallback Origin for Custom Hostnames
      operationId: custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - origin
              properties:
                origin:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_origin'
      responses:
        '200':
          description: Update Fallback Origin for Custom Hostnames response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response'
        4XX:
          description: Update Fallback Origin for Custom Hostnames response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_fallback_origin_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/custom_ns:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Account Custom Nameserver Related Zone Metadata
      description: 'Get metadata for account-level custom nameservers on a zone.

        '
      operationId: account-level-custom-nameservers-usage-for-a-zone-get-account-custom-nameserver-related-zone-metadata
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-custom-nameservers_schemas-identifier'
      responses:
        '200':
          description: Get Account Custom Nameserver Related Zone Metadata response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-custom-nameservers_get_response'
        4XX:
          description: Get Account Custom Nameserver Related Zone Metadata response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-custom-nameservers_get_response'
                - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Set Account Custom Nameserver Related Zone Metadata
      description: 'Set metadata for account-level custom nameservers on a zone.


        If you would like new zones in the account to use account custom nameservers by default, use PUT /accounts/:identifier to set the account setting use_account_custom_ns_by_default to true.

        '
      operationId: account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-custom-nameservers_schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-custom-nameservers_zone_metadata'
      responses:
        '200':
          description: Set Account Custom Nameserver Related Zone Metadata response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-custom-nameservers_schemas-empty_response'
        4XX:
          description: Set Account Custom Nameserver Related Zone Metadata response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-custom-nameservers_schemas-empty_response'
                - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/dcv_delegation/uuid:
    get:
      tags:
      - Zones
      summary: Cloudflare Retrieve the DCV Delegation unique identifier.
      description: Retrieve the account and zone specific unique identifier used as part of the CNAME target for DCV Delegation.
      operationId: dcv-delegation-uuid-get
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Retrieve the DCV Delegation unique identifier response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_dcv_delegation_response'
        4XX:
          description: Retrieve the DCV Delegation unique identifier response failure.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_dcv_delegation_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/dns_records:
    get:
      tags:
      - Zones
      summary: Cloudflare List DNS Records
      description: List, search, sort, and filter a zones' DNS records.
      operationId: dns-records-for-a-zone-list-dns-records
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      - name: name
        in: query
        schema:
          $ref: '#/components/schemas/dns-records_name'
      - name: type
        in: query
        schema:
          $ref: '#/components/schemas/dns-records_type'
      - name: content
        in: query
        schema:
          $ref: '#/components/schemas/dns-records_content'
      - name: proxied
        in: query
        schema:
          $ref: '#/components/schemas/dns-records_proxied'
      - name: match
        in: query
        schema:
          $ref: '#/components/schemas/dns-records_match'
      - name: comment
        in: query
        schema:
          type: string
          description: 'Exact value of the DNS record comment. This is a convenience alias for `comment.exact`.

            '
          example: Hello, world
      - name: comment.present
        in: query
        schema:
          type: string
          description: 'If this parameter is present, only records *with* a comment are returned.

            '
      - name: comment.absent
        in: query
        schema:
          type: string
          description: 'If this parameter is present, only records *without* a comment are returned.

            '
      - name: comment.exact
        in: query
        schema:
          type: string
          description: 'Exact value of the DNS record comment. Comment filters are case-insensitive.

            '
          example: Hello, world
      - name: comment.contains
        in: query
        schema:
          type: string
          description: 'Substring of the DNS record comment. Comment filters are case-insensitive.

            '
          example: ello, worl
      - name: comment.startswith
        in: query
        schema:
          type: string
          description: 'Prefix of the DNS record comment. Comment filters are case-insensitive.

            '
          example: Hello, w
      - name: comment.endswith
        in: query
        schema:
          type: string
          description: 'Suffix of the DNS record comment. Comment filters are case-insensitive.

            '
          example: o, world
      - name: tag
        in: query
        schema:
          type: string
          description: 'Condition on the DNS record tag.


            Parameter values can be of the form `<tag-name>:<tag-value>` to search for an exact `name:value` pair, or just `<tag-name>` to search for records with a specific tag name regardless of its value.


            This is a convenience shorthand for the more powerful `tag.<predicate>` parameters.

            Examples:

            - `tag=important` is equivalent to `tag.present=important`

            - `tag=team:DNS` is equivalent to `tag.exact=team:DNS`

            '
          example: team:DNS
      - name: tag.present
        in: query
        schema:
          type: string
          description: 'Name of a tag which must be present on the DNS record. Tag filters are case-insensitive.

            '
          example: important
      - name: tag.absent
        in: query
        schema:
          type: string
          description: 'Name of a tag which must *not* be present on the DNS record. Tag filters are case-insensitive.

            '
          example: important
      - name: tag.exact
        in: query
        schema:
          type: string
          description: 'A tag and value, of the form `<tag-name>:<tag-value>`. The API will only return DNS records that have a tag named `<tag-name>` whose value is `<tag-value>`. Tag filters are case-insensitive.

            '
          example: greeting:Hello, world
      - name: tag.contains
        in: query
        schema:
          type: string
          description: 'A tag and value, of the form `<tag-name>:<tag-value>`. The API will only return DNS records that have a tag named `<tag-name>` whose value contains `<tag-value>`. Tag filters are case-insensitive.

            '
          example: greeting:ello, worl
      - name: tag.startswith
        in: query
        schema:
          type: string
          description: 'A tag and value, of the form `<tag-name>:<tag-value>`. The API will only return DNS records that have a tag named `<tag-name>` whose value starts with `<tag-value>`. Tag filters are case-insensitive.

            '
          example: greeting:Hello, w
      - name: tag.endswith
        in: query
        schema:
          type: string
          description: 'A tag and value, of the form `<tag-name>:<tag-value>`. The API will only return DNS records that have a tag named `<tag-name>` whose value ends with `<tag-value>`. Tag filters are case-insensitive.

            '
          example: greeting:o, world
      - name: search
        in: query
        schema:
          $ref: '#/components/schemas/dns-records_search'
      - name: tag_match
        in: query
        schema:
          $ref: '#/components/schemas/dns-records_tag_match'
      - name: page
        in: query
        schema:
          $ref: '#/components/schemas/dns-records_page'
      - name: per_page
        in: query
        schema:
          $ref: '#/components/schemas/dns-records_per_page'
      - name: order
        in: query
        schema:
          $ref: '#/components/schemas/dns-records_order'
      - name: direction
        in: query
        schema:
          $ref: '#/components/schemas/dns-records_direction'
      responses:
        '200':
          description: List DNS Records response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-records_dns_response_collection'
        4xx:
          description: List DNS Records response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-records_dns_response_collection'
                - $ref: '#/components/schemas/dns-records_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create DNS Record
      description: "Create a new DNS record for a zone.\n\nNotes:\n- A/AAAA records cannot exist on the same name as CNAME records.\n- NS records cannot exist on the same name as any other record type.\n- Domain names are always represented in Punycode, even if Unicode\n  characters were used when creating the record.\n"
      operationId: dns-records-for-a-zone-create-dns-record
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-records_dns-record'
      responses:
        '200':
          description: Create DNS Record response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-records_dns_response_single'
        4xx:
          description: Create DNS Record response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-records_dns_response_single'
                - $ref: '#/components/schemas/dns-records_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/dns_records/{dns_record_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete DNS Record
      operationId: dns-records-for-a-zone-delete-dns-record
      parameters:
      - name: dns_record_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete DNS Record response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    properties:
                      id:
                        $ref: '#/components/schemas/dns-records_identifier'
        4xx:
          description: Delete DNS Record response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/dns-records_identifier'
                - $ref: '#/components/schemas/dns-records_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare DNS Record Details
      operationId: dns-records-for-a-zone-dns-record-details
      parameters:
      - name: dns_record_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      responses:
        '200':
          description: DNS Record Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-records_dns_response_single'
        4xx:
          description: DNS Record Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-records_dns_response_single'
                - $ref: '#/components/schemas/dns-records_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Update DNS Record
      description: "Update an existing DNS record.\nNotes:\n- A/AAAA records cannot exist on the same name as CNAME records.\n- NS records cannot exist on the same name as any other record type.\n- Domain names are always represented in Punycode, even if Unicode\n  characters were used when creating the record.\n"
      operationId: dns-records-for-a-zone-patch-dns-record
      parameters:
      - name: dns_record_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-records_dns-record'
      responses:
        '200':
          description: Patch DNS Record response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-records_dns_response_single'
        4xx:
          description: Patch DNS Record response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-records_dns_response_single'
                - $ref: '#/components/schemas/dns-records_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Overwrite DNS Record
      description: "Overwrite an existing DNS record.\nNotes:\n- A/AAAA records cannot exist on the same name as CNAME records.\n- NS records cannot exist on the same name as any other record type.\n- Domain names are always represented in Punycode, even if Unicode\n  characters were used when creating the record.\n"
      operationId: dns-records-for-a-zone-update-dns-record
      parameters:
      - name: dns_record_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-records_dns-record'
      responses:
        '200':
          description: Update DNS Record response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-records_dns_response_single'
        4xx:
          description: Update DNS Record response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-records_dns_response_single'
                - $ref: '#/components/schemas/dns-records_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/dns_records/export:
    get:
      tags:
      - Zones
      summary: Cloudflare Export DNS Records
      description: 'You can export your [BIND config](https://en.wikipedia.org/wiki/Zone_file "Zone file") through this endpoint.


        See [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ "Import and export records") for more information.'
      operationId: dns-records-for-a-zone-export-dns-records
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      responses:
        '200':
          description: Export DNS Records response
          content:
            text/plain:
              schema:
                type: string
                description: Exported BIND zone file.
                example: 'www.example.com. 300 IN  A 127.0.0.1

                  '
        4XX:
          description: Export DNS Records response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-records_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/dns_records/import:
    post:
      tags:
      - Zones
      summary: Cloudflare Import DNS Records
      description: 'You can upload your [BIND config](https://en.wikipedia.org/wiki/Zone_file "Zone file") through this endpoint. It assumes that cURL is called from a location with bind_config.txt (valid BIND config) present.


        See [the documentation](https://developers.cloudflare.com/dns/manage-dns-records/how-to/import-and-export/ "Import and export records") for more information.'
      operationId: dns-records-for-a-zone-import-dns-records
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - file
              properties:
                file:
                  type: string
                  description: 'BIND config to import.


                    **Tip:** When using cURL, a file can be uploaded using `--form ''file=@bind_config.txt''`.

                    '
                  example: www.example.com. 300 IN  A 127.0.0.1
                proxied:
                  type: string
                  description: 'Whether or not proxiable records should receive the performance and security benefits of Cloudflare.


                    The value should be either `true` or `false`.'
                  default: 'false'
                  example: 'true'
      responses:
        '200':
          description: Import DNS Records response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-records_dns_response_import_scan'
        4XX:
          description: Import DNS Records response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-records_dns_response_import_scan'
                - $ref: '#/components/schemas/dns-records_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/dns_records/scan:
    post:
      tags:
      - Zones
      summary: Cloudflare Scan DNS Records
      description: Scan for common DNS records on your domain and automatically add them to your zone. Useful if you haven't updated your nameservers yet.
      operationId: dns-records-for-a-zone-scan-dns-records
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-records_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Scan DNS Records response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-records_dns_response_import_scan'
        4XX:
          description: Scan DNS Records response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-records_dns_response_import_scan'
                - $ref: '#/components/schemas/dns-records_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/dnssec:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete DNSSEC records
      description: Delete DNSSEC.
      operationId: dnssec-delete-dnssec-records
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dnssec_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete DNSSEC records response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dnssec_delete_dnssec_response_single'
        4XX:
          description: Delete DNSSEC records response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dnssec_delete_dnssec_response_single'
                - $ref: '#/components/schemas/dnssec_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare DNSSEC Details
      description: Details about DNSSEC status and configuration.
      operationId: dnssec-dnssec-details
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dnssec_identifier'
      responses:
        '200':
          description: DNSSEC Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dnssec_dnssec_response_single'
        4XX:
          description: DNSSEC Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dnssec_dnssec_response_single'
                - $ref: '#/components/schemas/dnssec_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Edit DNSSEC Status
      description: Enable or disable DNSSEC.
      operationId: dnssec-edit-dnssec-status
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dnssec_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                dnssec_multi_signer:
                  $ref: '#/components/schemas/dnssec_dnssec_multi_signer'
                dnssec_presigned:
                  $ref: '#/components/schemas/dnssec_dnssec_presigned'
                status:
                  description: Status of DNSSEC, based on user-desired state and presence of necessary records.
                  enum:
                  - active
                  - disabled
                  example: active
      responses:
        '200':
          description: Edit DNSSEC Status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dnssec_dnssec_response_single'
        4XX:
          description: Edit DNSSEC Status response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dnssec_dnssec_response_single'
                - $ref: '#/components/schemas/dnssec_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/firewall/access_rules/rules:
    get:
      tags:
      - Zones
      summary: Cloudflare List IP Access rules
      description: Fetches IP Access rules of a zone. You can filter the results using several optional parameters.
      operationId: ip-access-rules-for-a-zone-list-ip-access-rules
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: filters
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_schemas-filters'
      - name: egs-pagination.json
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_egs-pagination'
      - name: page
        in: query
        schema:
          type: number
          description: Requested page within paginated list of results.
          example: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: Maximum number of results requested.
          example: 20
      - name: order
        in: query
        schema:
          type: string
          description: The field used to sort returned rules.
          enum:
          - configuration.target
          - configuration.value
          - mode
          example: mode
      - name: direction
        in: query
        schema:
          type: string
          description: The direction used to sort returned rules.
          enum:
          - asc
          - desc
          example: desc
      responses:
        '200':
          description: List IP Access rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_rule_collection_response'
        4xx:
          description: List IP Access rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_rule_collection_response'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create an IP Access rule
      description: 'Creates a new IP Access rule for a zone.


        Note: To create an IP Access rule that applies to multiple zones, refer to [IP Access rules for a user](#ip-access-rules-for-a-user) or [IP Access rules for an account](#ip-access-rules-for-an-account) as appropriate.'
      operationId: ip-access-rules-for-a-zone-create-an-ip-access-rule
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - mode
              - configuration
              - notes
              properties:
                configuration:
                  $ref: '#/components/schemas/legacy-jhs_schemas-configuration'
                mode:
                  $ref: '#/components/schemas/legacy-jhs_schemas-mode'
                notes:
                  $ref: '#/components/schemas/legacy-jhs_notes'
      responses:
        '200':
          description: Create an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_rule_single_response'
        4xx:
          description: Create an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_rule_single_response'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/firewall/access_rules/rules/{identifier}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete an IP Access rule
      description: 'Deletes an IP Access rule defined at the zone level.


        Optionally, you can use the `cascade` property to specify that you wish to delete similar rules in other zones managed by the same zone owner.'
      operationId: ip-access-rules-for-a-zone-delete-an-ip-access-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_rule_components-schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                cascade:
                  type: string
                  description: The level to attempt to delete similar rules defined for other zones with the same owner. The default value is `none`, which will only delete the current rule. Using `basic` will delete rules that match the same action (mode) and configuration, while using `aggressive` will delete rules that match the same configuration.
                  enum:
                  - none
                  - basic
                  - aggressive
                  default: none
      responses:
        '200':
          description: Delete an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_rule_single_id_response'
        4xx:
          description: Delete an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_rule_single_id_response'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Update an IP Access rule
      description: Updates an IP Access rule defined at the zone level. You can only update the rule action (`mode` parameter) and notes.
      operationId: ip-access-rules-for-a-zone-update-an-ip-access-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_rule_components-schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                mode:
                  $ref: '#/components/schemas/legacy-jhs_schemas-mode'
                notes:
                  $ref: '#/components/schemas/legacy-jhs_notes'
      responses:
        '200':
          description: Update an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_rule_single_response'
        4xx:
          description: Update an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_rule_single_response'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/firewall/waf/packages/{package_id}/groups:
    get:
      tags:
      - Zones
      summary: Cloudflare List WAF rule groups
      description: 'Fetches the WAF rule groups in a WAF package.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-rule-groups-list-waf-rule-groups
      parameters:
      - name: package_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_schemas-identifier'
      - name: mode
        in: query
        schema:
          $ref: '#/components/schemas/waf-managed-rules_mode'
      - name: page
        in: query
        schema:
          type: number
          description: The page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: The number of rule groups per page.
          default: 50
          minimum: 5
          maximum: 100
      - name: order
        in: query
        schema:
          description: The field used to sort returned rule groups.
          enum:
          - mode
          - rules_count
          example: mode
      - name: direction
        in: query
        schema:
          description: The direction used to sort returned rule groups.
          enum:
          - asc
          - desc
          example: desc
      - name: match
        in: query
        schema:
          description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
          enum:
          - any
          - all
          default: all
      - name: name
        in: query
        schema:
          type: string
          description: The name of the rule group.
          example: Project Honey Pot
          readOnly: true
      - name: rules_count
        in: query
        schema:
          type: number
          description: The number of rules in the current rule group.
          default: 0
          example: 10
          readOnly: true
      responses:
        '200':
          description: List WAF rule groups response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waf-managed-rules_rule_group_response_collection'
        4XX:
          description: List WAF rule groups response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waf-managed-rules_rule_group_response_collection'
                - $ref: '#/components/schemas/waf-managed-rules_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/firewall/waf/packages/{package_id}/groups/{group_id}:
    get:
      tags:
      - Zones
      summary: Cloudflare Get a WAF rule group
      description: 'Fetches the details of a WAF rule group.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-rule-groups-get-a-waf-rule-group
      parameters:
      - name: group_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
      - name: package_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_schemas-identifier'
      responses:
        '200':
          description: Get a WAF rule group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waf-managed-rules_rule_group_response_single'
        4XX:
          description: Get a WAF rule group response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waf-managed-rules_rule_group_response_single'
                - $ref: '#/components/schemas/waf-managed-rules_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Update a WAF rule group
      description: 'Updates a WAF rule group. You can update the state (`mode` parameter) of a rule group.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-rule-groups-update-a-waf-rule-group
      parameters:
      - name: group_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
      - name: package_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                mode:
                  $ref: '#/components/schemas/waf-managed-rules_mode'
      responses:
        '200':
          description: Update a WAF rule group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waf-managed-rules_rule_group_response_single'
        4XX:
          description: Update a WAF rule group response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waf-managed-rules_rule_group_response_single'
                - $ref: '#/components/schemas/waf-managed-rules_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/firewall/waf/packages/{package_id}/rules:
    get:
      tags:
      - Zones
      summary: Cloudflare List WAF rules
      description: 'Fetches WAF rules in a WAF package.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-rules-list-waf-rules
      parameters:
      - name: package_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_schemas-identifier'
      - name: mode
        in: query
        schema:
          type: string
          description: The action/mode a rule has been overridden to perform.
          enum:
          - DIS
          - CHL
          - BLK
          - SIM
          example: CHL
      - name: group_id
        in: query
        schema:
          $ref: '#/components/schemas/waf-managed-rules_components-schemas-identifier'
      - name: page
        in: query
        schema:
          type: number
          description: The page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: The number of rules per page.
          default: 50
          minimum: 5
          maximum: 100
      - name: order
        in: query
        schema:
          type: string
          description: The field used to sort returned rules.
          enum:
          - priority
          - group_id
          - description
          example: status
      - name: direction
        in: query
        schema:
          type: string
          description: The direction used to sort returned rules.
          enum:
          - asc
          - desc
          example: desc
      - name: match
        in: query
        schema:
          type: string
          description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
          enum:
          - any
          - all
          default: all
      - name: description
        in: query
        schema:
          type: string
          description: The public description of the WAF rule.
          example: SQL injection prevention for SELECT statements
          readOnly: true
      - name: priority
        in: query
        schema:
          type: string
          description: The order in which the individual WAF rule is executed within its rule group.
          readOnly: true
      responses:
        '200':
          description: List WAF rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waf-managed-rules_rule_response_collection'
        4XX:
          description: List WAF rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waf-managed-rules_rule_response_collection'
                - $ref: '#/components/schemas/waf-managed-rules_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{rule_id}:
    get:
      tags:
      - Zones
      summary: Cloudflare Get a WAF rule
      description: 'Fetches the details of a WAF rule in a WAF package.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-rules-get-a-waf-rule
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
      - name: package_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_schemas-identifier'
      responses:
        '200':
          description: Get a WAF rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waf-managed-rules_rule_response_single'
        4XX:
          description: Get a WAF rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waf-managed-rules_rule_response_single'
                - $ref: '#/components/schemas/waf-managed-rules_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Update a WAF rule
      description: 'Updates a WAF rule. You can only update the mode/action of the rule.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-rules-update-a-waf-rule
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
      - name: package_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waf-managed-rules_schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                mode:
                  description: The mode/action of the rule when triggered. You must use a value from the `allowed_modes` array of the current rule.
                  enum:
                  - default
                  - disable
                  - simulate
                  - block
                  - challenge
                  - 'on'
                  - 'off'
                  example: 'on'
      responses:
        '200':
          description: Update a WAF rule response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waf-managed-rules_rule_response_single'
                - properties:
                    result:
                      oneOf:
                      - $ref: '#/components/schemas/waf-managed-rules_anomaly_rule'
                      - $ref: '#/components/schemas/waf-managed-rules_traditional_deny_rule'
                      - $ref: '#/components/schemas/waf-managed-rules_traditional_allow_rule'
        4XX:
          description: Update a WAF rule response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/waf-managed-rules_rule_response_single'
                  - properties:
                      result:
                        oneOf:
                        - $ref: '#/components/schemas/waf-managed-rules_anomaly_rule'
                        - $ref: '#/components/schemas/waf-managed-rules_traditional_deny_rule'
                        - $ref: '#/components/schemas/waf-managed-rules_traditional_allow_rule'
                - $ref: '#/components/schemas/waf-managed-rules_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/hold:
    delete:
      tags:
      - Zones
      summary: Cloudflare Remove Zone Hold
      description: 'Stop enforcement of a zone hold on the zone, permanently or temporarily, allowing the

        creation and activation of zones with this zone''s hostname.'
      operationId: zones-0-hold-delete
      parameters:
      - name: zone_id
        in: path
        description: Zone ID
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      - name: hold_after
        in: query
        description: 'If `hold_after` is provided, the hold will be temporarily disabled,

          then automatically re-enabled by the system at the time specified

          in this RFC3339-formatted timestamp. Otherwise, the hold will be

          disabled indefinitely.'
        schema:
          type: string
        example: '2023-01-31T15:56:36+00:00'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    result:
                      type: object
                      properties:
                        hold:
                          type: boolean
                          example: false
                        hold_after:
                          type: string
                        include_subdomains:
                          type: string
                          example: false
        4XX:
          description: Client Error
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_schemas-api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get Zone Hold
      description: Retrieve whether the zone is subject to a zone hold, and metadata about the hold.
      operationId: zones-0-hold-get
      parameters:
      - name: zone_id
        in: path
        description: Zone ID
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_api-response-single'
                - type: object
                  properties:
                    result:
                      type: object
                      properties:
                        hold:
                          type: boolean
                          example: true
                        hold_after:
                          type: string
                          example: '2023-01-31T15:56:36+00:00'
                        include_subdomains:
                          type: string
                          example: false
        4XX:
          description: Client Error
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_schemas-api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Zone Hold
      description: Enforce a zone hold on the zone, blocking the creation and activation of zones with this zone's hostname.
      operationId: zones-0-hold-post
      parameters:
      - name: zone_id
        in: path
        description: Zone ID
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      - name: include_subdomains
        in: query
        description: 'If provided, the zone hold will extend to block any subdomain of the given zone, as well

          as SSL4SaaS Custom Hostnames. For example, a zone hold on a zone with the hostname

          ''example.com'' and include_subdomains=true will block ''example.com'',

          ''staging.example.com'', ''api.staging.example.com'', etc.'
        schema:
          type: boolean
        example: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_api-response-single'
                - type: object
                  properties:
                    result:
                      type: object
                      properties:
                        hold:
                          type: boolean
                          example: true
                        hold_after:
                          type: string
                          example: '2023-01-31T15:56:36+00:00'
                        include_subdomains:
                          type: string
                          example: true
        4XX:
          description: Client Error
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_schemas-api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/hostnames/settings/{setting_id}:
    get:
      tags:
      - Zones
      summary: Cloudflare List TLS setting for hostnames
      description: List the requested TLS setting for the hostnames under this zone.
      operationId: per-hostname-tls-settings-list
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: setting_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_setting_id'
      responses:
        '200':
          description: List per-hostname TLS settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response_collection'
        4XX:
          description: List per-hostname TLS settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response_collection'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/hostnames/settings/{setting_id}/{hostname}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete TLS setting for hostname
      description: Delete the tls setting value for the hostname.
      operationId: per-hostname-tls-settings-delete
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: setting_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_setting_id'
      - name: hostname
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname'
      responses:
        '200':
          description: Delete TLS setting for hostname response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response_delete'
        4XX:
          description: Delete TLS setting for hostname response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response_delete'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Edit TLS setting for hostname
      description: Update the tls setting value for the hostname.
      operationId: per-hostname-tls-settings-put
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: setting_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_setting_id'
      - name: hostname
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_value'
      responses:
        '200':
          description: Edit TLS setting for hostname response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response'
        4XX:
          description: Edit TLS setting for hostname response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_per_hostname_settings_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/keyless_certificates:
    get:
      tags:
      - Zones
      summary: Cloudflare List Keyless SSL Configurations
      description: List all Keyless SSL configurations for a given zone.
      operationId: keyless-ssl-for-a-zone-list-keyless-ssl-configurations
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: List Keyless SSL Configurations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_collection'
        4XX:
          description: List Keyless SSL Configurations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_collection'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Keyless SSL Configuration
      operationId: keyless-ssl-for-a-zone-create-keyless-ssl-configuration
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - host
              - port
              - certificate
              properties:
                bundle_method:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_bundle_method'
                certificate:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate'
                host:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_host'
                name:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_name_write'
                port:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_port'
                tunnel:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_tunnel'
      responses:
        '200':
          description: Create Keyless SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single'
        4XX:
          description: Create Keyless SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/keyless_certificates/{keyless_certificate_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Keyless SSL Configuration
      operationId: keyless-ssl-for-a-zone-delete-keyless-ssl-configuration
      parameters:
      - name: keyless_certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Keyless SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single_id'
        4XX:
          description: Delete Keyless SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single_id'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get Keyless SSL Configuration
      description: Get details for one Keyless SSL configuration.
      operationId: keyless-ssl-for-a-zone-get-keyless-ssl-configuration
      parameters:
      - name: keyless_certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Get Keyless SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single'
        4XX:
          description: Get Keyless SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Edit Keyless SSL Configuration
      description: 'This will update attributes of a Keyless SSL. Consists of one or more of the following:  host,name,port.'
      operationId: keyless-ssl-for-a-zone-edit-keyless-ssl-configuration
      parameters:
      - name: keyless_certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled_write'
                host:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_host'
                name:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_name_write'
                port:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_port'
                tunnel:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_tunnel'
      responses:
        '200':
          description: Edit Keyless SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single'
        4XX:
          description: Edit Keyless SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/load_balancers:
    get:
      tags:
      - Zones
      summary: Cloudflare List Load Balancers
      description: List configured load balancers.
      operationId: load-balancers-list-load-balancers
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
      responses:
        '200':
          description: List Load Balancers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-response_collection'
        4XX:
          description: List Load Balancers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-response_collection'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Load Balancer
      description: Create a new load balancer.
      operationId: load-balancers-create-load-balancer
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - default_pools
              - fallback_pool
              properties:
                adaptive_routing:
                  $ref: '#/components/schemas/load-balancing_adaptive_routing'
                country_pools:
                  $ref: '#/components/schemas/load-balancing_country_pools'
                default_pools:
                  $ref: '#/components/schemas/load-balancing_default_pools'
                description:
                  $ref: '#/components/schemas/load-balancing_components-schemas-description'
                fallback_pool:
                  $ref: '#/components/schemas/load-balancing_fallback_pool'
                location_strategy:
                  $ref: '#/components/schemas/load-balancing_location_strategy'
                name:
                  $ref: '#/components/schemas/load-balancing_components-schemas-name'
                pop_pools:
                  $ref: '#/components/schemas/load-balancing_pop_pools'
                proxied:
                  $ref: '#/components/schemas/load-balancing_proxied'
                random_steering:
                  $ref: '#/components/schemas/load-balancing_random_steering'
                region_pools:
                  $ref: '#/components/schemas/load-balancing_region_pools'
                rules:
                  $ref: '#/components/schemas/load-balancing_rules'
                session_affinity:
                  $ref: '#/components/schemas/load-balancing_session_affinity'
                session_affinity_attributes:
                  $ref: '#/components/schemas/load-balancing_session_affinity_attributes'
                session_affinity_ttl:
                  $ref: '#/components/schemas/load-balancing_session_affinity_ttl'
                steering_policy:
                  $ref: '#/components/schemas/load-balancing_steering_policy'
                ttl:
                  $ref: '#/components/schemas/load-balancing_ttl'
      responses:
        '200':
          description: Create Load Balancer response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response'
        4XX:
          description: Create Load Balancer response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/load_balancers/{load_balancer_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Load Balancer
      description: Delete a configured load balancer.
      operationId: load-balancers-delete-load-balancer
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
      - name: load_balancer_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Load Balancer response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_components-schemas-id_response'
        4XX:
          description: Delete Load Balancer response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_components-schemas-id_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    get:
      tags:
      - Zones
      summary: Cloudflare Load Balancer Details
      description: Fetch a single configured load balancer.
      operationId: load-balancers-load-balancer-details
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
      - name: load_balancer_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
      responses:
        '200':
          description: Load Balancer Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response'
        4XX:
          description: Load Balancer Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Patch Load Balancer
      description: Apply changes to an existing load balancer, overwriting the supplied properties.
      operationId: load-balancers-patch-load-balancer
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
      - name: load_balancer_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                adaptive_routing:
                  $ref: '#/components/schemas/load-balancing_adaptive_routing'
                country_pools:
                  $ref: '#/components/schemas/load-balancing_country_pools'
                default_pools:
                  $ref: '#/components/schemas/load-balancing_default_pools'
                description:
                  $ref: '#/components/schemas/load-balancing_components-schemas-description'
                enabled:
                  $ref: '#/components/schemas/load-balancing_components-schemas-enabled'
                fallback_pool:
                  $ref: '#/components/schemas/load-balancing_fallback_pool'
                location_strategy:
                  $ref: '#/components/schemas/load-balancing_location_strategy'
                name:
                  $ref: '#/components/schemas/load-balancing_components-schemas-name'
                pop_pools:
                  $ref: '#/components/schemas/load-balancing_pop_pools'
                proxied:
                  $ref: '#/components/schemas/load-balancing_proxied'
                random_steering:
                  $ref: '#/components/schemas/load-balancing_random_steering'
                region_pools:
                  $ref: '#/components/schemas/load-balancing_region_pools'
                rules:
                  $ref: '#/components/schemas/load-balancing_rules'
                session_affinity:
                  $ref: '#/components/schemas/load-balancing_session_affinity'
                session_affinity_attributes:
                  $ref: '#/components/schemas/load-balancing_session_affinity_attributes'
                session_affinity_ttl:
                  $ref: '#/components/schemas/load-balancing_session_affinity_ttl'
                steering_policy:
                  $ref: '#/components/schemas/load-balancing_steering_policy'
                ttl:
                  $ref: '#/components/schemas/load-balancing_ttl'
      responses:
        '200':
          description: Patch Load Balancer response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response'
        4XX:
          description: Patch Load Balancer response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Load Balancer
      description: Update a configured load balancer.
      operationId: load-balancers-update-load-balancer
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
      - name: load_balancer_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - default_pools
              - fallback_pool
              properties:
                adaptive_routing:
                  $ref: '#/components/schemas/load-balancing_adaptive_routing'
                country_pools:
                  $ref: '#/components/schemas/load-balancing_country_pools'
                default_pools:
                  $ref: '#/components/schemas/load-balancing_default_pools'
                description:
                  $ref: '#/components/schemas/load-balancing_components-schemas-description'
                enabled:
                  $ref: '#/components/schemas/load-balancing_components-schemas-enabled'
                fallback_pool:
                  $ref: '#/components/schemas/load-balancing_fallback_pool'
                location_strategy:
                  $ref: '#/components/schemas/load-balancing_location_strategy'
                name:
                  $ref: '#/components/schemas/load-balancing_components-schemas-name'
                pop_pools:
                  $ref: '#/components/schemas/load-balancing_pop_pools'
                proxied:
                  $ref: '#/components/schemas/load-balancing_proxied'
                random_steering:
                  $ref: '#/components/schemas/load-balancing_random_steering'
                region_pools:
                  $ref: '#/components/schemas/load-balancing_region_pools'
                rules:
                  $ref: '#/components/schemas/load-balancing_rules'
                session_affinity:
                  $ref: '#/components/schemas/load-balancing_session_affinity'
                session_affinity_attributes:
                  $ref: '#/components/schemas/load-balancing_session_affinity_attributes'
                session_affinity_ttl:
                  $ref: '#/components/schemas/load-balancing_session_affinity_ttl'
                steering_policy:
                  $ref: '#/components/schemas/load-balancing_steering_policy'
                ttl:
                  $ref: '#/components/schemas/load-balancing_ttl'
      responses:
        '200':
          description: Update Load Balancer response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response'
        4XX:
          description: Update Load Balancer response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-single_response'
                - $ref: '#/components/schemas/load-balancing_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_id}/logpush/datasets/{dataset_id}/fields:
    get:
      tags:
      - Zones
      summary: Cloudflare List fields
      description: Lists all fields available for a dataset. The response result is an object with key-value pairs, where keys are field names, and values are descriptions.
      operationId: get-zones-zone_identifier-logpush-datasets-dataset-fields
      parameters:
      - name: dataset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_dataset'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      responses:
        '200':
          description: List fields response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_logpush_field_response_collection'
        4XX:
          description: List fields response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_logpush_field_response_collection'
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/logpush/datasets/{dataset_id}/jobs:
    get:
      tags:
      - Zones
      summary: Cloudflare List Logpush jobs for a dataset
      description: Lists Logpush jobs for a zone for a dataset.
      operationId: get-zones-zone_identifier-logpush-datasets-dataset-jobs
      parameters:
      - name: dataset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_dataset'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      responses:
        '200':
          description: List Logpush jobs for a dataset response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_collection'
        4XX:
          description: List Logpush jobs for a dataset response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_logpush_job_response_collection'
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/logpush/edge:
    get:
      tags:
      - Zones
      summary: Cloudflare List Instant Logs jobs
      description: Lists Instant Logs jobs for a zone.
      operationId: get-zones-zone_identifier-logpush-edge-jobs
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      responses:
        '200':
          description: List Instant Logs jobs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_instant_logs_job_response_collection'
        4XX:
          description: List Instant Logs jobs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_instant_logs_job_response_collection'
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Instant Logs job
      description: Creates a new Instant Logs job for a zone.
      operationId: post-zones-zone_identifier-logpush-edge-jobs
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                fields:
                  $ref: '#/components/schemas/logpush_fields'
                filter:
                  $ref: '#/components/schemas/logpush_filter'
                sample:
                  $ref: '#/components/schemas/logpush_sample'
      responses:
        '200':
          description: Create Instant Logs job response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_instant_logs_job_response_single'
        4XX:
          description: Create Instant Logs job response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_instant_logs_job_response_single'
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/logpush/jobs:
    get:
      tags:
      - Zones
      summary: Cloudflare List Logpush jobs
      description: Lists Logpush jobs for a zone.
      operationId: get-zones-zone_identifier-logpush-jobs
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      responses:
        '200':
          description: List Logpush jobs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_collection'
        4XX:
          description: List Logpush jobs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_logpush_job_response_collection'
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Logpush job
      description: Creates a new Logpush job for a zone.
      operationId: post-zones-zone_identifier-logpush-jobs
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - destination_conf
              properties:
                dataset:
                  $ref: '#/components/schemas/logpush_dataset'
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
                enabled:
                  $ref: '#/components/schemas/logpush_enabled'
                frequency:
                  $ref: '#/components/schemas/logpush_frequency'
                logpull_options:
                  $ref: '#/components/schemas/logpush_logpull_options'
                name:
                  $ref: '#/components/schemas/logpush_name'
                output_options:
                  $ref: '#/components/schemas/logpush_output_options'
                ownership_challenge:
                  $ref: '#/components/schemas/logpush_ownership_challenge'
      responses:
        '200':
          description: Create Logpush job response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_single'
        4XX:
          description: Create Logpush job response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_logpush_job_response_single'
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/logpush/jobs/{job_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Logpush job
      description: Deletes a Logpush job.
      operationId: delete-zones-zone_identifier-logpush-jobs-job_identifier
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Logpush job response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_api-response-common'
                - properties:
                    result:
                      type: object
                      example: {}
                      nullable: true
        4XX:
          description: Delete Logpush job response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/logpush_api-response-common'
                  - properties:
                      result:
                        type: object
                        example: {}
                        nullable: true
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get Logpush job details
      description: Gets the details of a Logpush job.
      operationId: get-zones-zone_identifier-logpush-jobs-job_identifier
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      responses:
        '200':
          description: Get Logpush job details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_single'
        4XX:
          description: Get Logpush job details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_logpush_job_response_single'
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Logpush job
      description: Updates a Logpush job.
      operationId: put-zones-zone_identifier-logpush-jobs-job_identifier
      parameters:
      - name: job_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
                enabled:
                  $ref: '#/components/schemas/logpush_enabled'
                frequency:
                  $ref: '#/components/schemas/logpush_frequency'
                logpull_options:
                  $ref: '#/components/schemas/logpush_logpull_options'
                output_options:
                  $ref: '#/components/schemas/logpush_output_options'
                ownership_challenge:
                  $ref: '#/components/schemas/logpush_ownership_challenge'
      responses:
        '200':
          description: Update Logpush job response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_logpush_job_response_single'
        4XX:
          description: Update Logpush job response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_logpush_job_response_single'
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/logpush/ownership:
    post:
      tags:
      - Zones
      summary: Cloudflare Get ownership challenge
      description: Gets a new ownership challenge sent to your destination.
      operationId: post-zones-zone_identifier-logpush-ownership
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - destination_conf
              properties:
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
      responses:
        '200':
          description: Get ownership challenge response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_get_ownership_response'
        4XX:
          description: Get ownership challenge response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_get_ownership_response'
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/logpush/ownership/validate:
    post:
      tags:
      - Zones
      summary: Cloudflare Validate ownership challenge
      description: Validates ownership challenge of the destination.
      operationId: post-zones-zone_identifier-logpush-ownership-validate
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - destination_conf
              - ownership_challenge
              properties:
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
                ownership_challenge:
                  $ref: '#/components/schemas/logpush_ownership_challenge'
      responses:
        '200':
          description: Validate ownership challenge response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_validate_ownership_response'
        4XX:
          description: Validate ownership challenge response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_validate_ownership_response'
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/logpush/validate/destination/exists:
    post:
      tags:
      - Zones
      summary: Cloudflare Check destination exists
      description: Checks if there is an existing job with a destination.
      operationId: post-zones-zone_identifier-logpush-validate-destination-exists
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - destination_conf
              properties:
                destination_conf:
                  $ref: '#/components/schemas/logpush_destination_conf'
      responses:
        '200':
          description: Check destination exists response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_destination_exists_response'
        4XX:
          description: Check destination exists response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_destination_exists_response'
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/logpush/validate/origin:
    post:
      tags:
      - Zones
      summary: Cloudflare Validate origin
      description: Validates logpull origin with logpull_options.
      operationId: post-zones-zone_identifier-logpush-validate-origin
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/logpush_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - logpull_options
              properties:
                logpull_options:
                  $ref: '#/components/schemas/logpush_logpull_options'
      responses:
        '200':
          description: Validate origin response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_validate_response'
        4XX:
          description: Validate origin response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_validate_response'
                - $ref: '#/components/schemas/logpush_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/managed_headers:
    get:
      tags:
      - Zones
      summary: Cloudflare List Managed Transforms
      description: Fetches a list of all Managed Transforms.
      operationId: managed-transforms-list-managed-transforms
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_identifier'
      responses:
        '200':
          description: List Managed Transforms response
          content:
            application/json:
              schema:
                type: object
                properties:
                  managed_request_headers:
                    $ref: '#/components/schemas/rulesets_request_list'
                  managed_response_headers:
                    $ref: '#/components/schemas/rulesets_request_list'
        4XX:
          description: List Managed Transforms response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    managed_request_headers:
                      $ref: '#/components/schemas/rulesets_request_list'
                    managed_response_headers:
                      $ref: '#/components/schemas/rulesets_request_list'
                - $ref: '#/components/schemas/rulesets_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Update status of Managed Transforms
      description: Updates the status of one or more Managed Transforms.
      operationId: managed-transforms-update-status-of-managed-transforms
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - managed_request_headers
              - managed_response_headers
              properties:
                managed_request_headers:
                  $ref: '#/components/schemas/rulesets_request_list'
                managed_response_headers:
                  $ref: '#/components/schemas/rulesets_request_list'
      responses:
        '200':
          description: Update status of Managed Transforms response
          content:
            application/json:
              schema:
                type: object
                properties:
                  managed_request_headers:
                    $ref: '#/components/schemas/rulesets_response_list'
                  managed_response_headers:
                    $ref: '#/components/schemas/rulesets_response_list'
        4XX:
          description: Update status of Managed Transforms response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    managed_request_headers:
                      $ref: '#/components/schemas/rulesets_response_list'
                    managed_response_headers:
                      $ref: '#/components/schemas/rulesets_response_list'
                - $ref: '#/components/schemas/rulesets_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/origin_tls_client_auth:
    get:
      tags:
      - Zones
      summary: Cloudflare List Certificates
      operationId: zone-level-authenticated-origin-pulls-list-certificates
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: List Certificates response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_collection'
        4XX:
          description: List Certificates response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_collection'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Upload Certificate
      description: Upload your own certificate you want Cloudflare to use for edge-to-origin communication to override the shared certificate. Please note that it is important to keep only one certificate active. Also, make sure to enable zone-level authenticated origin pulls by making a PUT call to settings endpoint to see the uploaded certificate in use.
      operationId: zone-level-authenticated-origin-pulls-upload-certificate
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - certificate
              - private_key
              properties:
                certificate:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate'
                private_key:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_private_key'
      responses:
        '200':
          description: Upload Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single'
        4XX:
          description: Upload Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/origin_tls_client_auth/{certificate_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Certificate
      operationId: zone-level-authenticated-origin-pulls-delete-certificate
      parameters:
      - name: certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single'
        4XX:
          description: Delete Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get Certificate Details
      operationId: zone-level-authenticated-origin-pulls-get-certificate-details
      parameters:
      - name: certificate_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Get Certificate Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single'
        4XX:
          description: Get Certificate Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/origin_tls_client_auth/hostnames:
    put:
      tags:
      - Zones
      summary: Cloudflare Enable or Disable a Hostname for Client Authentication
      description: 'Associate a hostname to a certificate and enable, disable or invalidate the association. If disabled, client certificate will not be sent to the hostname even if activated at the zone level. 100 maximum associations on a single certificate are allowed. Note: Use a null value for parameter *enabled* to invalidate the association.'
      operationId: per-hostname-authenticated-origin-pull-enable-or-disable-a-hostname-for-client-authentication
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - config
              properties:
                config:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_config'
      responses:
        '200':
          description: Enable or Disable a Hostname for Client Authentication response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_aop_response_collection'
        4XX:
          description: Enable or Disable a Hostname for Client Authentication response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_aop_response_collection'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/origin_tls_client_auth/hostnames/{hostname}:
    get:
      tags:
      - Zones
      summary: Cloudflare Get the Hostname Status for Client Authentication
      operationId: per-hostname-authenticated-origin-pull-get-the-hostname-status-for-client-authentication
      parameters:
      - name: hostname
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostname'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Get the Hostname Status for Client Authentication response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_aop_single_response'
        4XX:
          description: Get the Hostname Status for Client Authentication response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_aop_single_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/origin_tls_client_auth/hostnames/certificates:
    get:
      tags:
      - Zones
      summary: Cloudflare List Certificates
      operationId: per-hostname-authenticated-origin-pull-list-certificates
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: List Certificates response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_collection'
        4XX:
          description: List Certificates response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_collection'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Upload a Hostname Client Certificate
      description: Upload a certificate to be used for client authentication on a hostname. 10 hostname certificates per zone are allowed.
      operationId: per-hostname-authenticated-origin-pull-upload-a-hostname-client-certificate
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - certificate
              - private_key
              properties:
                certificate:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate'
                private_key:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-private_key'
      responses:
        '200':
          description: Upload a Hostname Client Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single'
        4XX:
          description: Upload a Hostname Client Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/origin_tls_client_auth/settings:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Enablement Setting for Zone
      description: Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.
      operationId: zone-level-authenticated-origin-pulls-get-enablement-setting-for-zone
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Get Enablement Setting for Zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled_response'
        4XX:
          description: Get Enablement Setting for Zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Set Enablement for Zone
      description: Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.
      operationId: zone-level-authenticated-origin-pulls-set-enablement-for-zone
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - enabled
              properties:
                enabled:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled'
      responses:
        '200':
          description: Set Enablement for Zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled_response'
        4XX:
          description: Set Enablement for Zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/page_shield:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Page Shield settings
      description: Fetches the Page Shield settings.
      operationId: page-shield-get-page-shield-settings
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_identifier'
      responses:
        '200':
          description: Get Page Shield settings response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/page-shield_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/page-shield_get-zone-settings-response'
        4XX:
          description: Get Page Shield settings response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/page-shield_zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/page-shield_get-zone-settings-response'
                - $ref: '#/components/schemas/page-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Page Shield settings
      description: Updates Page Shield settings.
      operationId: page-shield-update-page-shield-settings
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                enabled:
                  $ref: '#/components/schemas/page-shield_enabled'
                use_cloudflare_reporting_endpoint:
                  $ref: '#/components/schemas/page-shield_use_cloudflare_reporting_endpoint'
                use_connection_url_path:
                  $ref: '#/components/schemas/page-shield_use_connection_url_path'
      responses:
        '200':
          description: Update Page Shield settings response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/page-shield_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/page-shield_update-zone-settings-response'
        4XX:
          description: Update Page Shield settings response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/page-shield_zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/page-shield_update-zone-settings-response'
                - $ref: '#/components/schemas/page-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/page_shield/connections:
    get:
      tags:
      - Zones
      summary: Cloudflare List Page Shield connections
      description: Lists all connections detected by Page Shield.
      operationId: page-shield-list-page-shield-connections
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_identifier'
      - name: exclude_urls
        in: query
        schema:
          type: string
          description: 'Excludes connections whose URL contains one of the URL-encoded URLs separated by commas.

            '
          example: blog.cloudflare.com,www.example
      - name: urls
        in: query
        schema:
          type: string
          description: 'Includes connections whose URL contain one or more URL-encoded URLs separated by commas.

            '
          example: blog.cloudflare.com,www.example
      - name: hosts
        in: query
        schema:
          type: string
          description: 'Includes connections that match one or more URL-encoded hostnames separated by commas.


            Wildcards are supported at the start and end of each hostname to support starts with, ends with

            and contains. If no wildcards are used, results will be filtered by exact match

            '
          example: blog.cloudflare.com,www.example*,*cloudflare.com
      - name: page
        in: query
        schema:
          type: string
          description: 'The current page number of the paginated results.


            We additionally support a special value "all". When "all" is used, the API will return all the connections

            with the applied filters in a single page. Additionally, when using this value, the API will not return

            the categorisation data for the URL and domain of the connections. This feature is best-effort and it may

            only work for zones with a low number of connections

            '
          example: 2
      - name: per_page
        in: query
        schema:
          type: number
          description: The number of results per page.
          example: 100
          minimum: 1
          maximum: 100
      - name: order_by
        in: query
        schema:
          type: string
          description: The field used to sort returned connections.
          enum:
          - first_seen_at
          - last_seen_at
          example: first_seen_at
      - name: direction
        in: query
        schema:
          type: string
          description: The direction used to sort returned connections.
          enum:
          - asc
          - desc
          example: asc
      - name: prioritize_malicious
        in: query
        schema:
          type: boolean
          description: When true, malicious connections appear first in the returned connections.
          example: true
      - name: exclude_cdn_cgi
        in: query
        schema:
          type: boolean
          description: When true, excludes connections seen in a `/cdn-cgi` path from the returned connections. The default value is true.
          example: true
      - name: status
        in: query
        schema:
          type: string
          description: 'Filters the returned connections using a comma-separated list of connection statuses. Accepted values: `active`, `infrequent`, and `inactive`. The default value is `active`.'
          example: active,inactive
      - name: page_url
        in: query
        schema:
          type: string
          description: 'Includes connections that match one or more page URLs (separated by commas) where they were last seen


            Wildcards are supported at the start and end of each page URL to support starts with, ends with

            and contains. If no wildcards are used, results will be filtered by exact match

            '
          example: example.com/page,*/checkout,example.com/*,*checkout*
      - name: export
        in: query
        schema:
          type: string
          description: Export the list of connections as a file. Cannot be used with per_page or page options.
          enum:
          - csv
          example: csv
      responses:
        '200':
          description: List Page Shield connections response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/page-shield_list-zone-connections-response'
        4XX:
          description: List Page Shield connections response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/page-shield_list-zone-connections-response'
                - $ref: '#/components/schemas/page-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/page_shield/connections/{connection_id}:
    get:
      tags:
      - Zones
      summary: Cloudflare Get a Page Shield connection
      description: Fetches a connection detected by Page Shield by connection ID.
      operationId: page-shield-get-a-page-shield-connection
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_identifier'
      - name: connection_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_resource_id'
      responses:
        '200':
          description: Get a Page Shield connection response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/page-shield_get-zone-connection-response'
        4XX:
          description: Get a Page Shield connection response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/page-shield_get-zone-connection-response'
                - $ref: '#/components/schemas/page-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/page_shield/policies:
    get:
      tags:
      - Zones
      summary: Cloudflare List Page Shield policies
      description: Lists all Page Shield policies.
      operationId: page-shield-list-page-shield-policies
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_identifier'
      responses:
        '200':
          description: List Page Shield policies response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/page-shield_list-zone-policies-response'
        4XX:
          description: List Page Shield policies response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/page-shield_list-zone-policies-response'
                - $ref: '#/components/schemas/page-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create a Page Shield policy
      description: Create a Page Shield policy.
      operationId: page-shield-create-a-page-shield-policy
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                action:
                  $ref: '#/components/schemas/page-shield_pageshield-policy-action'
                description:
                  $ref: '#/components/schemas/page-shield_pageshield-policy-description'
                enabled:
                  $ref: '#/components/schemas/page-shield_pageshield-policy-enabled'
                expression:
                  $ref: '#/components/schemas/page-shield_pageshield-policy-expression'
                value:
                  $ref: '#/components/schemas/page-shield_pageshield-policy-value'
      responses:
        '200':
          description: Create a Page Shield policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/page-shield_get-zone-policy-response'
        4XX:
          description: Create a Page Shield policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/page-shield_get-zone-policy-response'
                - $ref: '#/components/schemas/page-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/page_shield/policies/{policy_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a Page Shield policy
      description: Delete a Page Shield policy by ID.
      operationId: page-shield-delete-a-page-shield-policy
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_identifier'
      - name: policy_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_policy_id'
      responses:
        '204':
          description: Delete a Page Shield policy response
        4XX:
          description: Delete a Page Shield policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/page-shield_get-zone-policy-response'
                - $ref: '#/components/schemas/page-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get a Page Shield policy
      description: Fetches a Page Shield policy by ID.
      operationId: page-shield-get-a-page-shield-policy
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_identifier'
      - name: policy_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_policy_id'
      responses:
        '200':
          description: Get a Page Shield policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/page-shield_get-zone-policy-response'
        4XX:
          description: Get a Page Shield policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/page-shield_get-zone-policy-response'
                - $ref: '#/components/schemas/page-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update a Page Shield policy
      description: Update a Page Shield policy by ID.
      operationId: page-shield-update-a-page-shield-policy
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_identifier'
      - name: policy_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_policy_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                action:
                  $ref: '#/components/schemas/page-shield_pageshield-policy-action'
                description:
                  $ref: '#/components/schemas/page-shield_pageshield-policy-description'
                enabled:
                  $ref: '#/components/schemas/page-shield_pageshield-policy-enabled'
                expression:
                  $ref: '#/components/schemas/page-shield_pageshield-policy-expression'
                value:
                  $ref: '#/components/schemas/page-shield_pageshield-policy-value'
      responses:
        '200':
          description: Update a Page Shield policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/page-shield_get-zone-policy-response'
        4XX:
          description: Update a Page Shield policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/page-shield_get-zone-policy-response'
                - $ref: '#/components/schemas/page-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/page_shield/scripts:
    get:
      tags:
      - Zones
      summary: Cloudflare List Page Shield scripts
      description: Lists all scripts detected by Page Shield.
      operationId: page-shield-list-page-shield-scripts
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_identifier'
      - name: exclude_urls
        in: query
        schema:
          type: string
          description: 'Excludes scripts whose URL contains one of the URL-encoded URLs separated by commas.

            '
          example: blog.cloudflare.com,www.example
      - name: urls
        in: query
        schema:
          type: string
          description: 'Includes scripts whose URL contain one or more URL-encoded URLs separated by commas.

            '
          example: blog.cloudflare.com,www.example
      - name: hosts
        in: query
        schema:
          type: string
          description: 'Includes scripts that match one or more URL-encoded hostnames separated by commas.


            Wildcards are supported at the start and end of each hostname to support starts with, ends with

            and contains. If no wildcards are used, results will be filtered by exact match

            '
          example: blog.cloudflare.com,www.example*,*cloudflare.com
      - name: page
        in: query
        schema:
          type: string
          description: 'The current page number of the paginated results.


            We additionally support a special value "all". When "all" is used, the API will return all the scripts

            with the applied filters in a single page. Additionally, when using this value, the API will not return

            the script versions or categorisation data for the URL and domain of the scripts. This feature is

            best-effort and it may only work for zones with a low number of scripts

            '
          example: 2
      - name: per_page
        in: query
        schema:
          type: number
          description: The number of results per page.
          example: 100
          minimum: 1
          maximum: 100
      - name: order_by
        in: query
        schema:
          type: string
          description: The field used to sort returned scripts.
          enum:
          - first_seen_at
          - last_seen_at
          example: first_seen_at
      - name: direction
        in: query
        schema:
          type: string
          description: The direction used to sort returned scripts.
          enum:
          - asc
          - desc
          example: asc
      - name: prioritize_malicious
        in: query
        schema:
          type: boolean
          description: When true, malicious scripts appear first in the returned scripts.
          example: true
      - name: exclude_cdn_cgi
        in: query
        schema:
          type: boolean
          description: When true, excludes scripts seen in a `/cdn-cgi` path from the returned scripts. The default value is true.
          default: true
          example: true
      - name: exclude_duplicates
        in: query
        schema:
          type: boolean
          description: 'When true, excludes duplicate scripts. We consider a script duplicate of another if their javascript

            content matches and they share the same url host and zone hostname. In such case, we return the most

            recent script for the URL host and zone hostname combination.

            '
          default: true
          example: true
      - name: status
        in: query
        schema:
          type: string
          description: 'Filters the returned scripts using a comma-separated list of scripts statuses. Accepted values: `active`, `infrequent`, and `inactive`. The default value is `active`.'
          example: active,inactive
      - name: page_url
        in: query
        schema:
          type: string
          description: 'Includes scripts that match one or more page URLs (separated by commas) where they were last seen


            Wildcards are supported at the start and end of each page URL to support starts with, ends with

            and contains. If no wildcards are used, results will be filtered by exact match

            '
          example: example.com/page,*/checkout,example.com/*,*checkout*
      - name: export
        in: query
        schema:
          type: string
          description: Export the list of scripts as a file. Cannot be used with per_page or page options.
          enum:
          - csv
          example: csv
      responses:
        '200':
          description: List Page Shield scripts response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/page-shield_list-zone-scripts-response'
        4XX:
          description: List Page Shield scripts response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/page-shield_list-zone-scripts-response'
                - $ref: '#/components/schemas/page-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/page_shield/scripts/{script_id}:
    get:
      tags:
      - Zones
      summary: Cloudflare Get a Page Shield script
      description: Fetches a script detected by Page Shield by script ID.
      operationId: page-shield-get-a-page-shield-script
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_identifier'
      - name: script_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/page-shield_resource_id'
      responses:
        '200':
          description: Get a Page Shield script response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/page-shield_get-zone-script-response'
        4XX:
          description: Get a Page Shield script response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/page-shield_get-zone-script-response'
                - $ref: '#/components/schemas/page-shield_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/pagerules:
    get:
      tags:
      - Zones
      summary: Cloudflare List Page Rules
      description: Fetches Page Rules in a zone.
      operationId: page-rules-list-page-rules
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      - name: order
        in: query
        schema:
          type: string
          description: The field used to sort returned Page Rules.
          enum:
          - status
          - priority
          default: priority
          example: status
      - name: direction
        in: query
        schema:
          type: string
          description: The direction used to sort returned Page Rules.
          enum:
          - asc
          - desc
          default: desc
          example: desc
      - name: match
        in: query
        schema:
          type: string
          description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
          enum:
          - any
          - all
          default: all
      - name: status
        in: query
        schema:
          type: string
          description: The status of the Page Rule.
          enum:
          - active
          - disabled
          default: disabled
          example: active
      responses:
        '200':
          description: List Page Rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_pagerule_response_collection'
        4XX:
          description: List Page Rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_pagerule_response_collection'
                - $ref: '#/components/schemas/zones_schemas-api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create a Page Rule
      description: Creates a new Page Rule.
      operationId: page-rules-create-a-page-rule
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - targets
              - actions
              properties:
                actions:
                  $ref: '#/components/schemas/zones_actions'
                priority:
                  $ref: '#/components/schemas/zones_priority'
                status:
                  $ref: '#/components/schemas/zones_status'
                targets:
                  $ref: '#/components/schemas/zones_targets'
      responses:
        '200':
          description: Create a Page Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_pagerule_response_single'
        4XX:
          description: Create a Page Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_pagerule_response_single'
                - $ref: '#/components/schemas/zones_schemas-api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/pagerules/{pagerule_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a Page Rule
      description: Deletes an existing Page Rule.
      operationId: page-rules-delete-a-page-rule
      parameters:
      - name: pagerule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete a Page Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_schemas-api-response-single-id'
        4XX:
          description: Delete a Page Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_schemas-api-response-single-id'
                - $ref: '#/components/schemas/zones_schemas-api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get a Page Rule
      description: Fetches the details of a Page Rule.
      operationId: page-rules-get-a-page-rule
      parameters:
      - name: pagerule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      responses:
        '200':
          description: Get a Page Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_pagerule_response_single'
        4XX:
          description: Get a Page Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_pagerule_response_single'
                - $ref: '#/components/schemas/zones_schemas-api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Edit a Page Rule
      description: Updates one or more fields of an existing Page Rule.
      operationId: page-rules-edit-a-page-rule
      parameters:
      - name: pagerule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                actions:
                  $ref: '#/components/schemas/zones_actions'
                priority:
                  $ref: '#/components/schemas/zones_priority'
                status:
                  $ref: '#/components/schemas/zones_status'
                targets:
                  $ref: '#/components/schemas/zones_targets'
      responses:
        '200':
          description: Edit a Page Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_pagerule_response_single'
        4XX:
          description: Edit a Page Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_pagerule_response_single'
                - $ref: '#/components/schemas/zones_schemas-api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update a Page Rule
      description: Replaces the configuration of an existing Page Rule. The configuration of the updated Page Rule will exactly match the data passed in the API request.
      operationId: page-rules-update-a-page-rule
      parameters:
      - name: pagerule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - targets
              - actions
              properties:
                actions:
                  $ref: '#/components/schemas/zones_actions'
                priority:
                  $ref: '#/components/schemas/zones_priority'
                status:
                  $ref: '#/components/schemas/zones_status'
                targets:
                  $ref: '#/components/schemas/zones_targets'
      responses:
        '200':
          description: Update a Page Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_pagerule_response_single'
        4XX:
          description: Update a Page Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_pagerule_response_single'
                - $ref: '#/components/schemas/zones_schemas-api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/pagerules/settings:
    get:
      tags:
      - Zones
      summary: Cloudflare List available Page Rules settings
      description: Returns a list of settings (and their details) that Page Rules can apply to matching requests.
      operationId: available-page-rules-settings-list-available-page-rules-settings
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_schemas-identifier'
      responses:
        '200':
          description: List available Page Rules settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_pagerule_settings_response_collection'
        4XX:
          description: List available Page Rules settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_pagerule_settings_response_collection'
                - $ref: '#/components/schemas/zones_schemas-api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/purge_cache:
    post:
      tags:
      - Zones
      summary: Cloudflare Purge Cached Content
      description: '### Purge All Cached Content

        Removes ALL files from Cloudflare''s cache. All tiers can purge everything.


        ### Purge Cached Content by URL

        Granularly removes one or more files from Cloudflare''s cache by specifying URLs. All tiers can purge by URL.


        To purge files with custom cache keys, include the headers used to compute the cache key as in the example. If you have a device type or geo in your cache key, you will need to include the CF-Device-Type or CF-IPCountry headers. If you have lang in your cache key, you will need to include the Accept-Language header.


        **NB:** When including the Origin header, be sure to include the **scheme** and **hostname**. The port number can be omitted if it is the default port (80 for http, 443 for https), but must be included otherwise.


        ### Purge Cached Content by Tag, Host or Prefix

        Granularly removes one or more files from Cloudflare''s cache either by specifying the host, the associated Cache-Tag, or a Prefix. Only Enterprise customers are permitted to purge by Tag, Host or Prefix.


        **NB:** Cache-Tag, host, and prefix purging each have a rate limit of 30,000 purge API calls in every 24 hour period. You may purge up to 30 tags, hosts, or prefixes in one API call. This rate limit can be raised for customers who need to purge at higher volume.

        '
      operationId: zone-purge
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache-purge_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              anyOf:
              - $ref: '#/components/schemas/cache-purge_Flex'
              - $ref: '#/components/schemas/cache-purge_Everything'
              - $ref: '#/components/schemas/cache-purge_Files'
      responses:
        '200':
          description: Purge Cached Content
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cache-purge_api-response-single-id'
        4xx:
          description: Purge Cached Content failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache-purge_api-response-single-id'
                - $ref: '#/components/schemas/cache-purge_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/rulesets:
    get:
      tags:
      - Zones
      summary: Cloudflare List zone rulesets
      description: Fetches all rulesets at the zone level.
      operationId: listZoneRulesets
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      responses:
        '200':
          description: List zone rulesets response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetsResponse'
        4XX:
          description: List zone rulesets failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create a zone ruleset
      description: Creates a ruleset at the zone level.
      operationId: createZoneRuleset
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rulesets_CreateRulesetRequest'
      responses:
        '200':
          description: Create a zone ruleset response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetResponse'
        4XX:
          description: Create a zone ruleset failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/rulesets/{ruleset_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a zone ruleset
      description: Deletes all versions of an existing zone ruleset.
      operationId: deleteZoneRuleset
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      responses:
        '204':
          description: Delete a zone ruleset response
        4XX:
          description: Delete a zone ruleset failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get a zone ruleset
      description: Fetches the latest version of a zone ruleset.
      operationId: getZoneRuleset
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      responses:
        '200':
          description: Get a zone ruleset response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetResponse'
        4XX:
          description: Get a zone ruleset failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update a zone ruleset
      description: Updates a zone ruleset, creating a new version.
      operationId: updateZoneRuleset
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rulesets_UpdateRulesetRequest'
      responses:
        '200':
          description: Update a zone ruleset response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetResponse'
        4XX:
          description: Update a zone ruleset failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/rulesets/{ruleset_id}/rules:
    post:
      tags:
      - Zones
      summary: Cloudflare Create a zone ruleset rule
      description: Adds a new rule to a zone ruleset. The rule will be added to the end of the existing list of rules in the ruleset by default.
      operationId: createZoneRulesetRule
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rulesets_CreateOrUpdateRuleRequest'
      responses:
        '200':
          description: Create a zone ruleset rule response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetResponse'
        4XX:
          description: Create a zone ruleset rule failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a zone ruleset rule
      description: Deletes an existing rule from a zone ruleset.
      operationId: deleteZoneRulesetRule
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RuleId'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      responses:
        '200':
          description: Delete a zone ruleset rule response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetResponse'
        4XX:
          description: Delete a zone ruleset rule failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Update a zone ruleset rule
      description: Updates an existing rule in a zone ruleset.
      operationId: updateZoneRulesetRule
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RuleId'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rulesets_CreateOrUpdateRuleRequest'
      responses:
        '200':
          description: Update a zone ruleset rule response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetResponse'
        4XX:
          description: Update a zone ruleset rule failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/rulesets/{ruleset_id}/versions:
    get:
      tags:
      - Zones
      summary: Cloudflare List a zone ruleset's versions
      description: Fetches the versions of a zone ruleset.
      operationId: listZoneRulesetVersions
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      responses:
        '200':
          description: List a zone ruleset's versions response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetsResponse'
        4XX:
          description: List a zone ruleset's versions failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a zone ruleset version
      description: Deletes an existing version of a zone ruleset.
      operationId: deleteZoneRulesetVersion
      parameters:
      - name: ruleset_version
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetVersion'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      responses:
        '204':
          description: Delete a zone ruleset version response.
        4XX:
          description: Delete a zone ruleset version failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get a zone ruleset version
      description: Fetches a specific version of a zone ruleset.
      operationId: getZoneRulesetVersion
      parameters:
      - name: ruleset_version
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetVersion'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetId'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      responses:
        '200':
          description: Get a zone ruleset version response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetResponse'
        4XX:
          description: Get a zone ruleset version failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint:
    get:
      tags:
      - Zones
      summary: Cloudflare Get a zone entry point ruleset
      description: Fetches the latest version of the zone entry point ruleset for a given phase.
      operationId: getZoneEntrypointRuleset
      parameters:
      - name: ruleset_phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetPhase'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      responses:
        '200':
          description: Get a zone entry point ruleset response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetResponse'
        4XX:
          description: Get a zone entry point ruleset failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update a zone entry point ruleset
      description: Updates a zone entry point ruleset, creating a new version.
      operationId: updateZoneEntrypointRuleset
      parameters:
      - name: ruleset_phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetPhase'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rulesets_UpdateRulesetRequest'
      responses:
        '200':
          description: Update a zone entry point ruleset response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetResponse'
        4XX:
          description: Update a zone entry point ruleset failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions:
    get:
      tags:
      - Zones
      summary: Cloudflare List a zone entry point ruleset's versions
      description: Fetches the versions of a zone entry point ruleset.
      operationId: listZoneEntrypointRulesetVersions
      parameters:
      - name: ruleset_phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetPhase'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      responses:
        '200':
          description: List a zone entry point ruleset's versions response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetsResponse'
        4XX:
          description: List a zone entry point ruleset's versions failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}:
    get:
      tags:
      - Zones
      summary: Cloudflare Get a zone entry point ruleset version
      description: Fetches a specific version of a zone entry point ruleset.
      operationId: getZoneEntrypointRulesetVersion
      parameters:
      - name: ruleset_version
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetVersion'
      - name: ruleset_phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_RulesetPhase'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_ZoneId'
      responses:
        '200':
          description: Get a zone entry point ruleset version response.
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_Response'
                - properties:
                    result:
                      $ref: '#/components/schemas/rulesets_RulesetResponse'
        4XX:
          description: Get a zone entry point ruleset version failure response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_FailureResponse'
      security:
      - api_token: []
      - api_email: []
        api_key: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/secondary_dns/force_axfr:
    post:
      tags:
      - Zones
      summary: Cloudflare Force AXFR
      description: Sends AXFR zone transfer request to primary nameserver(s).
      operationId: secondary-dns-(-secondary-zone)-force-axfr
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Force AXFR response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_force_response'
        4XX:
          description: Force AXFR response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_force_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/secondary_dns/incoming:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Secondary Zone Configuration
      description: Delete secondary zone configuration for incoming zone transfers.
      operationId: secondary-dns-(-secondary-zone)-delete-secondary-zone-configuration
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Secondary Zone Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_id_response'
        4XX:
          description: Delete Secondary Zone Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_id_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Secondary Zone Configuration Details
      description: Get secondary zone configuration for incoming zone transfers.
      operationId: secondary-dns-(-secondary-zone)-secondary-zone-configuration-details
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      responses:
        '200':
          description: Secondary Zone Configuration Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_single_response_incoming'
        4XX:
          description: Secondary Zone Configuration Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_single_response_incoming'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Secondary Zone Configuration
      description: Create secondary zone configuration for incoming zone transfers.
      operationId: secondary-dns-(-secondary-zone)-create-secondary-zone-configuration
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/secondary-dns_dns-secondary-secondary-zone'
      responses:
        '200':
          description: Create Secondary Zone Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_single_response_incoming'
        4XX:
          description: Create Secondary Zone Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_single_response_incoming'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Secondary Zone Configuration
      description: Update secondary zone configuration for incoming zone transfers.
      operationId: secondary-dns-(-secondary-zone)-update-secondary-zone-configuration
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/secondary-dns_dns-secondary-secondary-zone'
      responses:
        '200':
          description: Update Secondary Zone Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_single_response_incoming'
        4XX:
          description: Update Secondary Zone Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_single_response_incoming'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/secondary_dns/outgoing:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Primary Zone Configuration
      description: Delete primary zone configuration for outgoing zone transfers.
      operationId: secondary-dns-(-primary-zone)-delete-primary-zone-configuration
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Primary Zone Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_id_response'
        4XX:
          description: Delete Primary Zone Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_id_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Primary Zone Configuration Details
      description: Get primary zone configuration for outgoing zone transfers.
      operationId: secondary-dns-(-primary-zone)-primary-zone-configuration-details
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      responses:
        '200':
          description: Primary Zone Configuration Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_single_response_outgoing'
        4XX:
          description: Primary Zone Configuration Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_single_response_outgoing'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Primary Zone Configuration
      description: Create primary zone configuration for outgoing zone transfers.
      operationId: secondary-dns-(-primary-zone)-create-primary-zone-configuration
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/secondary-dns_single_request_outgoing'
      responses:
        '200':
          description: Create Primary Zone Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_single_response_outgoing'
        4XX:
          description: Create Primary Zone Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_single_response_outgoing'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Primary Zone Configuration
      description: Update primary zone configuration for outgoing zone transfers.
      operationId: secondary-dns-(-primary-zone)-update-primary-zone-configuration
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/secondary-dns_single_request_outgoing'
      responses:
        '200':
          description: Update Primary Zone Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_single_response_outgoing'
        4XX:
          description: Update Primary Zone Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_single_response_outgoing'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/secondary_dns/outgoing/disable:
    post:
      tags:
      - Zones
      summary: Cloudflare Disable Outgoing Zone Transfers
      description: Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone.
      operationId: secondary-dns-(-primary-zone)-disable-outgoing-zone-transfers
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Disable Outgoing Zone Transfers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_disable_transfer_response'
        4XX:
          description: Disable Outgoing Zone Transfers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_disable_transfer_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/secondary_dns/outgoing/enable:
    post:
      tags:
      - Zones
      summary: Cloudflare Enable Outgoing Zone Transfers
      description: Enable outgoing zone transfers for primary zone.
      operationId: secondary-dns-(-primary-zone)-enable-outgoing-zone-transfers
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Enable Outgoing Zone Transfers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_enable_transfer_response'
        4XX:
          description: Enable Outgoing Zone Transfers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_enable_transfer_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/secondary_dns/outgoing/force_notify:
    post:
      tags:
      - Zones
      summary: Cloudflare Force DNS NOTIFY
      description: Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone.
      operationId: secondary-dns-(-primary-zone)-force-dns-notify
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Force DNS NOTIFY response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_schemas-force_response'
        4XX:
          description: Force DNS NOTIFY response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_schemas-force_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/secondary_dns/outgoing/status:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Outgoing Zone Transfer Status
      description: Get primary zone transfer status.
      operationId: secondary-dns-(-primary-zone)-get-outgoing-zone-transfer-status
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/secondary-dns_identifier'
      responses:
        '200':
          description: Get Outgoing Zone Transfer Status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/secondary-dns_enable_transfer_response'
        4XX:
          description: Get Outgoing Zone Transfer Status response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/secondary-dns_enable_transfer_response'
                - $ref: '#/components/schemas/secondary-dns_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings:
    get:
      tags:
      - Zones
      summary: Cloudflare Get all Zone settings
      description: Available settings for your user in relation to a zone.
      operationId: zone-settings-get-all-zone-settings
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get all Zone settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_zone_settings_response_collection'
        4XX:
          description: Get all Zone settings response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Edit zone settings info
      description: Edit settings for a zone.
      operationId: zone-settings-edit-zone-settings-info
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - items
              properties:
                items:
                  type: array
                  description: One or more zone setting objects. Must contain an ID and a value.
                  example:
                  - id: always_online
                    value: 'on'
                  - id: browser_cache_ttl
                    value: 18000
                  - id: ip_geolocation
                    value: 'off'
                  minItems: 1
                  items:
                    $ref: '#/components/schemas/zones_setting'
      responses:
        '200':
          description: Edit zone settings info response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_zone_settings_response_collection'
        4XX:
          description: Edit zone settings info response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/0rtt:
    get:
      tags:
      - Zones
      summary: Cloudflare Get 0-RTT session resumption setting
      description: Gets 0-RTT session resumption setting.
      operationId: zone-settings-get-0-rtt-session-resumption-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get 0-RTT session resumption setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_0rtt'
        4XX:
          description: Get 0-RTT session resumption setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change 0-RTT session resumption setting
      description: Changes the 0-RTT session resumption setting.
      operationId: zone-settings-change-0-rtt-session-resumption-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_0rtt_value'
      responses:
        '200':
          description: Change 0-RTT session resumption setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_0rtt'
        4XX:
          description: Change 0-RTT session resumption setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/advanced_ddos:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Advanced DDOS setting
      description: Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones.
      operationId: zone-settings-get-advanced-ddos-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Advanced DDOS setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_advanced_ddos'
        4XX:
          description: Get Advanced DDOS setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/always_online:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Always Online setting
      description: When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.
      operationId: zone-settings-get-always-online-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Always Online setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_always_online'
        4XX:
          description: Get Always Online setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Always Online setting
      description: When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.
      operationId: zone-settings-change-always-online-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_always_online_value'
      responses:
        '200':
          description: Change Always Online setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_always_online'
        4XX:
          description: Change Always Online setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/always_use_https:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Always Use HTTPS setting
      description: Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.
      operationId: zone-settings-get-always-use-https-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Always Use HTTPS setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_always_use_https'
        4XX:
          description: Get Always Use HTTPS setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Always Use HTTPS setting
      description: Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.
      operationId: zone-settings-change-always-use-https-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_always_use_https_value'
      responses:
        '200':
          description: Change Always Use HTTPS setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_always_use_https'
        4XX:
          description: Change Always Use HTTPS setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/automatic_https_rewrites:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Automatic HTTPS Rewrites setting
      description: Enable the Automatic HTTPS Rewrites feature for this zone.
      operationId: zone-settings-get-automatic-https-rewrites-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Automatic HTTPS Rewrites setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_automatic_https_rewrites'
        4XX:
          description: Get Automatic HTTPS Rewrites setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Automatic HTTPS Rewrites setting
      description: Enable the Automatic HTTPS Rewrites feature for this zone.
      operationId: zone-settings-change-automatic-https-rewrites-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_automatic_https_rewrites_value'
      responses:
        '200':
          description: Change Automatic HTTPS Rewrites setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_automatic_https_rewrites'
        4XX:
          description: Change Automatic HTTPS Rewrites setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/automatic_platform_optimization:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Automatic Platform Optimization for WordPress setting
      description: '[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/)

        serves your WordPress site from Cloudflare''s edge network and caches

        third-party fonts.

        '
      operationId: zone-settings-get-automatic_platform_optimization-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Automatic Platform Optimization for WordPress setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_automatic_platform_optimization'
        4XX:
          description: Get Automatic Platform Optimization for WordPress setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Automatic Platform Optimization for WordPress setting
      description: '[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/)

        serves your WordPress site from Cloudflare''s edge network and caches

        third-party fonts.

        '
      operationId: zone-settings-change-automatic_platform_optimization-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_automatic_platform_optimization'
      responses:
        '200':
          description: Change Automatic Platform Optimization for WordPress setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_automatic_platform_optimization'
        4XX:
          description: Change Automatic Platform Optimization for WordPress setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/brotli:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Brotli setting
      description: When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.
      operationId: zone-settings-get-brotli-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Brotli setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_brotli'
        4XX:
          description: Get Brotli setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Brotli setting
      description: When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.
      operationId: zone-settings-change-brotli-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_brotli_value'
      responses:
        '200':
          description: Change Brotli setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_brotli'
        4XX:
          description: Change Brotli setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/browser_cache_ttl:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Browser Cache TTL setting
      description: Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).
      operationId: zone-settings-get-browser-cache-ttl-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Browser Cache TTL setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_browser_cache_ttl'
        4XX:
          description: Get Browser Cache TTL setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Browser Cache TTL setting
      description: Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).
      operationId: zone-settings-change-browser-cache-ttl-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_browser_cache_ttl_value'
      responses:
        '200':
          description: Change Browser Cache TTL setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_browser_cache_ttl'
        4XX:
          description: Change Browser Cache TTL setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/browser_check:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Browser Check setting
      description: Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page.  It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).
      operationId: zone-settings-get-browser-check-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Browser Check setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_browser_check'
        4XX:
          description: Get Browser Check setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Browser Check setting
      description: Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page.  It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).
      operationId: zone-settings-change-browser-check-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_browser_check_value'
      responses:
        '200':
          description: Change Browser Check setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_browser_check'
        4XX:
          description: Change Browser Check setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/cache_level:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Cache Level setting
      description: Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).
      operationId: zone-settings-get-cache-level-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Cache Level setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_cache_level'
        4XX:
          description: Get Cache Level setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Cache Level setting
      description: Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).
      operationId: zone-settings-change-cache-level-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_cache_level_value'
      responses:
        '200':
          description: Change Cache Level setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_cache_level'
        4XX:
          description: Change Cache Level setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/challenge_ttl:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Challenge TTL setting
      description: Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).
      operationId: zone-settings-get-challenge-ttl-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Challenge TTL setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_challenge_ttl'
        4XX:
          description: Get Challenge TTL setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Challenge TTL setting
      description: Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).
      operationId: zone-settings-change-challenge-ttl-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_challenge_ttl_value'
      responses:
        '200':
          description: Change Challenge TTL setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_challenge_ttl'
        4XX:
          description: Change Challenge TTL setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/ciphers:
    get:
      tags:
      - Zones
      summary: Cloudflare Get ciphers setting
      description: Gets ciphers setting.
      operationId: zone-settings-get-ciphers-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get ciphers setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_ciphers'
        4XX:
          description: Get ciphers setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change ciphers setting
      description: Changes ciphers setting.
      operationId: zone-settings-change-ciphers-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_ciphers_value'
      responses:
        '200':
          description: Change ciphers setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_ciphers'
        4XX:
          description: Change ciphers setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/development_mode:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Development Mode setting
      description: Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.
      operationId: zone-settings-get-development-mode-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Development Mode setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_development_mode'
        4XX:
          description: Get Development Mode setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Development Mode setting
      description: Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.
      operationId: zone-settings-change-development-mode-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_development_mode_value'
      responses:
        '200':
          description: Change Development Mode setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_development_mode'
        4XX:
          description: Change Development Mode setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/early_hints:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Early Hints setting
      description: When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.
      operationId: zone-settings-get-early-hints-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Early Hints setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_early_hints'
        4XX:
          description: Get Early Hints setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Early Hints setting
      description: When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.
      operationId: zone-settings-change-early-hints-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_early_hints_value'
      responses:
        '200':
          description: Change Early Hints setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_early_hints'
        4XX:
          description: Change Early Hints setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/email_obfuscation:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Email Obfuscation setting
      description: Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).
      operationId: zone-settings-get-email-obfuscation-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Email Obfuscation setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_email_obfuscation'
        4XX:
          description: Get Email Obfuscation setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Email Obfuscation setting
      description: Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).
      operationId: zone-settings-change-email-obfuscation-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_email_obfuscation_value'
      responses:
        '200':
          description: Change Email Obfuscation setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_email_obfuscation'
        4XX:
          description: Change Email Obfuscation setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/fonts:
    get:
      tags:
      - Zones
      summary: Get Cloudflare Fonts setting
      description: 'Enhance your website''s font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain,

        boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.

        '
      operationId: zone-settings-get-fonts-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/speed_identifier'
      responses:
        '200':
          description: Get Cloudflare Fonts setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/speed_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/speed_cloudflare_fonts'
        4XX:
          description: Get Cloudflare Fonts setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/speed_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Change Cloudflare Fonts setting
      description: 'Enhance your website''s font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain,

        boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.

        '
      operationId: zone-settings-change-fonts-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/speed_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/speed_cloudflare_fonts_value'
      responses:
        '200':
          description: Change Cloudflare Fonts setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/speed_api-response-common'
                - properties:
                    result:
                      $ref: '#/components/schemas/speed_cloudflare_fonts'
        4XX:
          description: Change Cloudflare Fonts setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/speed_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/h2_prioritization:
    get:
      tags:
      - Zones
      summary: Cloudflare Get HTTP/2 Edge Prioritization setting
      description: 'Gets HTTP/2 Edge Prioritization setting.

        '
      operationId: zone-settings-get-h2_prioritization-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get HTTP/2 Edge Prioritization setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_h2_prioritization'
        4XX:
          description: Get HTTP/2 Edge Prioritization setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change HTTP/2 Edge Prioritization setting
      description: 'Gets HTTP/2 Edge Prioritization setting.

        '
      operationId: zone-settings-change-h2_prioritization-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_h2_prioritization'
      responses:
        '200':
          description: Change HTTP/2 Edge Prioritization setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_h2_prioritization'
        4XX:
          description: Change HTTP/2 Edge Prioritization setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/hotlink_protection:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Hotlink Protection setting
      description: When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).
      operationId: zone-settings-get-hotlink-protection-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Hotlink Protection setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_hotlink_protection'
        4XX:
          description: Get Hotlink Protection setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Hotlink Protection setting
      description: When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).
      operationId: zone-settings-change-hotlink-protection-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_hotlink_protection_value'
      responses:
        '200':
          description: Change Hotlink Protection setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_hotlink_protection'
        4XX:
          description: Change Hotlink Protection setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/http2:
    get:
      tags:
      - Zones
      summary: Cloudflare Get HTTP2 setting
      description: Value of the HTTP2 setting.
      operationId: zone-settings-get-h-t-t-p-2-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get HTTP2 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_http2'
        4XX:
          description: Get HTTP2 setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change HTTP2 setting
      description: Value of the HTTP2 setting.
      operationId: zone-settings-change-h-t-t-p-2-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_http2_value'
      responses:
        '200':
          description: Change HTTP2 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_http2'
        4XX:
          description: Change HTTP2 setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/http3:
    get:
      tags:
      - Zones
      summary: Cloudflare Get HTTP3 setting
      description: Value of the HTTP3 setting.
      operationId: zone-settings-get-h-t-t-p-3-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get HTTP3 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_http3'
        4XX:
          description: Get HTTP3 setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change HTTP3 setting
      description: Value of the HTTP3 setting.
      operationId: zone-settings-change-h-t-t-p-3-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_http3_value'
      responses:
        '200':
          description: Change HTTP3 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_http3'
        4XX:
          description: Change HTTP3 setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/image_resizing:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Image Resizing setting
      description: 'Image Resizing provides on-demand resizing, conversion and optimisation

        for images served through Cloudflare''s network. Refer to the

        [Image Resizing documentation](https://developers.cloudflare.com/images/)

        for more information.

        '
      operationId: zone-settings-get-image_resizing-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Image Resizing setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_image_resizing'
        4XX:
          description: Get Image Resizing setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Image Resizing setting
      description: 'Image Resizing provides on-demand resizing, conversion and optimisation

        for images served through Cloudflare''s network. Refer to the

        [Image Resizing documentation](https://developers.cloudflare.com/images/)

        for more information.

        '
      operationId: zone-settings-change-image_resizing-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_image_resizing'
      responses:
        '200':
          description: Change Image Resizing setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_image_resizing'
        4XX:
          description: Change Image Resizing setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/ip_geolocation:
    get:
      tags:
      - Zones
      summary: Cloudflare Get IP Geolocation setting
      description: Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).
      operationId: zone-settings-get-ip-geolocation-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get IP Geolocation setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_ip_geolocation'
        4XX:
          description: Get IP Geolocation setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change IP Geolocation setting
      description: Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).
      operationId: zone-settings-change-ip-geolocation-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_ip_geolocation_value'
      responses:
        '200':
          description: Change IP Geolocation setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_ip_geolocation'
        4XX:
          description: Change IP Geolocation setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/ipv6:
    get:
      tags:
      - Zones
      summary: Cloudflare Get IPv6 setting
      description: Enable IPv6 on all subdomains that are Cloudflare enabled.  (https://support.cloudflare.com/hc/en-us/articles/200168586).
      operationId: zone-settings-get-i-pv6-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get IPv6 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_ipv6'
        4XX:
          description: Get IPv6 setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change IPv6 setting
      description: Enable IPv6 on all subdomains that are Cloudflare enabled.  (https://support.cloudflare.com/hc/en-us/articles/200168586).
      operationId: zone-settings-change-i-pv6-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_ipv6_value'
      responses:
        '200':
          description: Change IPv6 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_ipv6'
        4XX:
          description: Change IPv6 setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/min_tls_version:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Minimum TLS Version setting
      description: Gets Minimum TLS Version setting.
      operationId: zone-settings-get-minimum-tls-version-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Minimum TLS Version setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_min_tls_version'
        4XX:
          description: Get Minimum TLS Version setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Minimum TLS Version setting
      description: Changes Minimum TLS Version setting.
      operationId: zone-settings-change-minimum-tls-version-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_min_tls_version_value'
      responses:
        '200':
          description: Change Minimum TLS Version setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_min_tls_version'
        4XX:
          description: Change Minimum TLS Version setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/minify:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Minify setting
      description: Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.
      operationId: zone-settings-get-minify-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Minify setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_minify'
        4XX:
          description: Get Minify setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Minify setting
      description: Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.
      operationId: zone-settings-change-minify-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_minify_value'
      responses:
        '200':
          description: Change Minify setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_minify'
        4XX:
          description: Change Minify setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/mirage:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Mirage setting
      description: 'Automatically optimize image loading for website visitors on mobile

        devices. Refer to our [blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed)

        for more information.

        '
      operationId: zone-settings-get-mirage-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Mirage setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_mirage'
        4XX:
          description: Get Mirage setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Mirage setting
      description: Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed) for more information.
      operationId: zone-settings-change-web-mirage-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_mirage_value'
      responses:
        '200':
          description: Change Mirage setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_mirage'
        4XX:
          description: Change Mirage setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/mobile_redirect:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Mobile Redirect setting
      description: Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.
      operationId: zone-settings-get-mobile-redirect-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Mobile Redirect setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_mobile_redirect'
        4XX:
          description: Get Mobile Redirect setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Mobile Redirect setting
      description: Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.
      operationId: zone-settings-change-mobile-redirect-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_mobile_redirect_value'
      responses:
        '200':
          description: Change Mobile Redirect setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_mobile_redirect'
        4XX:
          description: Change Mobile Redirect setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/nel:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Network Error Logging setting
      description: 'Enable Network Error Logging reporting on your zone. (Beta)

        '
      operationId: zone-settings-get-nel-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Network Error Logging setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_nel'
        4XX:
          description: Get Network Error Logging setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Network Error Logging setting
      description: Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/nel-solving-mobile-speed) for more information.
      operationId: zone-settings-change-nel-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_nel'
      responses:
        '200':
          description: Change Network Error Logging setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_nel'
        4XX:
          description: Change Network Error Logging setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/opportunistic_encryption:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Opportunistic Encryption setting
      description: Gets Opportunistic Encryption setting.
      operationId: zone-settings-get-opportunistic-encryption-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Opportunistic Encryption setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_opportunistic_encryption'
        4XX:
          description: Get Opportunistic Encryption setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Opportunistic Encryption setting
      description: Changes Opportunistic Encryption setting.
      operationId: zone-settings-change-opportunistic-encryption-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_opportunistic_encryption_value'
      responses:
        '200':
          description: Change Opportunistic Encryption setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_opportunistic_encryption'
        4XX:
          description: Change Opportunistic Encryption setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/opportunistic_onion:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Opportunistic Onion setting
      description: Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.
      operationId: zone-settings-get-opportunistic-onion-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Opportunistic Onion setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_opportunistic_onion'
        4XX:
          description: Get Opportunistic Onion setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Opportunistic Onion setting
      description: Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.
      operationId: zone-settings-change-opportunistic-onion-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_opportunistic_onion_value'
      responses:
        '200':
          description: Change Opportunistic Onion setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_opportunistic_onion'
        4XX:
          description: Change Opportunistic Onion setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/orange_to_orange:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Orange to Orange (O2O) setting
      description: 'Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other

        zones also on Cloudflare.

        '
      operationId: zone-settings-get-orange_to_orange-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Orange to Orange (O2O) setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_orange_to_orange'
        4XX:
          description: Get Orange to Orange (O2O) setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Orange to Orange (O2O) setting
      description: 'Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other

        zones also on Cloudflare.

        '
      operationId: zone-settings-change-orange_to_orange-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_orange_to_orange'
      responses:
        '200':
          description: Change Orange to Orange (O2O) setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_orange_to_orange'
        4XX:
          description: Change Orange to Orange (O2O) setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/origin_error_page_pass_thru:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Enable Error Pages On setting
      description: Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.
      operationId: zone-settings-get-enable-error-pages-on-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Enable Error Pages On setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_origin_error_page_pass_thru'
        4XX:
          description: Get Enable Error Pages On setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Enable Error Pages On setting
      description: Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.
      operationId: zone-settings-change-enable-error-pages-on-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_origin_error_page_pass_thru_value'
      responses:
        '200':
          description: Change Enable Error Pages On setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_origin_error_page_pass_thru'
        4XX:
          description: Change Enable Error Pages On setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/origin_max_http_version:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Origin Max HTTP Version Setting
      description: Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except ENT where it is "1"
      operationId: zone-cache-settings-get-origin-max-http-version-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      responses:
        '200':
          description: Get Origin Max HTTP Version Setting Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_origin_max_http_version_response_value'
              examples:
                max_http_version_2:
                  $ref: '#/components/examples/cache_origin_max_http_version_2'
        4XX:
          description: Get Origin Max HTTP Version Setting Response Failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/cache_origin_max_http_version_response_value'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
              examples:
                Error:
                  $ref: '#/components/examples/cache_dummy_error_response'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Origin Max HTTP Version Setting
      description: Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except ENT where it is "1"
      operationId: zone-cache-settings-change-origin-max-http-version-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cache_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/cache_origin_max_http_version_value'
      responses:
        '200':
          description: Change Origin Max HTTP Version Setting Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_origin_max_http_version_response_value'
              examples:
                max_http_version_2:
                  $ref: '#/components/examples/cache_origin_max_http_version_2'
        4XX:
          description: Change Origin Max HTTP Version Response Failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/cache_zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/cache_origin_max_http_version_response_value'
                - $ref: '#/components/schemas/cache_api-response-common-failure'
              examples:
                Error:
                  $ref: '#/components/examples/cache_dummy_error_response'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/polish:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Polish setting
      description: 'Automatically optimize image loading for website visitors on mobile

        devices. Refer to our [blog post](http://blog.cloudflare.com/polish-solving-mobile-speed)

        for more information.

        '
      operationId: zone-settings-get-polish-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Polish setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_polish'
        4XX:
          description: Get Polish setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Polish setting
      description: Automatically optimize image loading for website visitors on mobile devices. Refer to our [blog post](http://blog.cloudflare.com/polish-solving-mobile-speed) for more information.
      operationId: zone-settings-change-polish-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_polish'
      responses:
        '200':
          description: Change Polish setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_polish'
        4XX:
          description: Change Polish setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/prefetch_preload:
    get:
      tags:
      - Zones
      summary: Cloudflare Get prefetch preload setting
      description: Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.
      operationId: zone-settings-get-prefetch-preload-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get prefetch preload setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_prefetch_preload'
        4XX:
          description: Get prefetch preload setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change prefetch preload setting
      description: Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.
      operationId: zone-settings-change-prefetch-preload-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_prefetch_preload_value'
      responses:
        '200':
          description: Change prefetch preload setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_prefetch_preload'
        4XX:
          description: Change prefetch preload setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/proxy_read_timeout:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Proxy Read Timeout setting
      description: 'Maximum time between two read operations from origin.

        '
      operationId: zone-settings-get-proxy_read_timeout-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Proxy Read Timeout setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_proxy_read_timeout'
        4XX:
          description: Get Proxy Read Timeout setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Proxy Read Timeout setting
      description: 'Maximum time between two read operations from origin.

        '
      operationId: zone-settings-change-proxy_read_timeout-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_proxy_read_timeout'
      responses:
        '200':
          description: Change Proxy Read Timeout setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_proxy_read_timeout'
        4XX:
          description: Change Proxy Read Timeout setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/pseudo_ipv4:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Pseudo IPv4 setting
      description: Value of the Pseudo IPv4 setting.
      operationId: zone-settings-get-pseudo-i-pv4-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Pseudo IPv4 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_pseudo_ipv4'
        4XX:
          description: Get Pseudo IPv4 setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Pseudo IPv4 setting
      description: Value of the Pseudo IPv4 setting.
      operationId: zone-settings-change-pseudo-i-pv4-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_pseudo_ipv4_value'
      responses:
        '200':
          description: Change Pseudo IPv4 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_pseudo_ipv4'
        4XX:
          description: Change Pseudo IPv4 setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/response_buffering:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Response Buffering setting
      description: Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.
      operationId: zone-settings-get-response-buffering-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Response Buffering setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_response_buffering'
        4XX:
          description: Get Response Buffering setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Response Buffering setting
      description: Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.
      operationId: zone-settings-change-response-buffering-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_response_buffering_value'
      responses:
        '200':
          description: Change Response Buffering setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_response_buffering'
        4XX:
          description: Change Response Buffering setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/rocket_loader:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Rocket Loader setting
      description: 'Rocket Loader is a general-purpose asynchronous JavaScript optimisation

        that prioritises rendering your content while loading your site''s

        Javascript asynchronously. Turning on Rocket Loader will immediately

        improve a web page''s rendering time sometimes measured as Time to First

        Paint (TTFP), and also the `window.onload` time (assuming there is

        JavaScript on the page). This can have a positive impact on your Google

        search ranking. When turned on, Rocket Loader will automatically defer

        the loading of all Javascript referenced in your HTML, with no

        configuration required. Refer to

        [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056)

        for more information.

        '
      operationId: zone-settings-get-rocket_loader-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Rocket Loader setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_rocket_loader'
        4XX:
          description: Get Rocket Loader setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Rocket Loader setting
      description: 'Rocket Loader is a general-purpose asynchronous JavaScript optimisation

        that prioritises rendering your content while loading your site''s

        Javascript asynchronously. Turning on Rocket Loader will immediately

        improve a web page''s rendering time sometimes measured as Time to First

        Paint (TTFP), and also the `window.onload` time (assuming there is

        JavaScript on the page). This can have a positive impact on your Google

        search ranking. When turned on, Rocket Loader will automatically defer

        the loading of all Javascript referenced in your HTML, with no

        configuration required. Refer to

        [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056)

        for more information.

        '
      operationId: zone-settings-change-rocket_loader-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_rocket_loader'
      responses:
        '200':
          description: Change Rocket Loader setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_rocket_loader'
        4XX:
          description: Change Rocket Loader setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/security_header:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Security Header (HSTS) setting
      description: Cloudflare security header for a zone.
      operationId: zone-settings-get-security-header-(-hsts)-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Security Header (HSTS) setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_security_header'
        4XX:
          description: Get Security Header (HSTS) setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Security Header (HSTS) setting
      description: Cloudflare security header for a zone.
      operationId: zone-settings-change-security-header-(-hsts)-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_security_header_value'
      responses:
        '200':
          description: Change Security Header (HSTS) setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_security_header'
        4XX:
          description: Change Security Header (HSTS) setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/security_level:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Security Level setting
      description: Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).
      operationId: zone-settings-get-security-level-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Security Level setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_security_level'
        4XX:
          description: Get Security Level setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Security Level setting
      description: Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).
      operationId: zone-settings-change-security-level-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_security_level_value'
      responses:
        '200':
          description: Change Security Level setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_security_level'
        4XX:
          description: Change Security Level setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/server_side_exclude:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Server Side Exclude setting
      description: 'If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: <!--sse--><!--/sse-->. For example: <!--sse-->  Bad visitors won''t see my phone number, 555-555-5555 <!--/sse-->. Note: SSE only will work with HTML. If you have HTML minification enabled, you won''t see the SSE tags in your HTML source when it''s served through Cloudflare. SSE will still function in this case, as Cloudflare''s HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor''s computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).'
      operationId: zone-settings-get-server-side-exclude-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Server Side Exclude setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_server_side_exclude'
        4XX:
          description: Get Server Side Exclude setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Server Side Exclude setting
      description: 'If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: <!--sse--><!--/sse-->. For example: <!--sse-->  Bad visitors won''t see my phone number, 555-555-5555 <!--/sse-->. Note: SSE only will work with HTML. If you have HTML minification enabled, you won''t see the SSE tags in your HTML source when it''s served through Cloudflare. SSE will still function in this case, as Cloudflare''s HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor''s computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).'
      operationId: zone-settings-change-server-side-exclude-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_server_side_exclude_value'
      responses:
        '200':
          description: Change Server Side Exclude setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_server_side_exclude'
        4XX:
          description: Change Server Side Exclude setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/sort_query_string_for_cache:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Enable Query String Sort setting
      description: Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.
      operationId: zone-settings-get-enable-query-string-sort-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Enable Query String Sort setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_sort_query_string_for_cache'
        4XX:
          description: Get Enable Query String Sort setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Enable Query String Sort setting
      description: Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.
      operationId: zone-settings-change-enable-query-string-sort-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_sort_query_string_for_cache_value'
      responses:
        '200':
          description: Change Enable Query String Sort setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_sort_query_string_for_cache'
        4XX:
          description: Change Enable Query String Sort setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/ssl:
    get:
      tags:
      - Zones
      summary: Cloudflare Get SSL setting
      description: 'SSL encrypts your visitor''s connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server  (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don''t need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full:  SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).'
      operationId: zone-settings-get-ssl-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get SSL setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_ssl'
        4XX:
          description: Get SSL setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change SSL setting
      description: 'SSL encrypts your visitor''s connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server  (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don''t need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full:  SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).'
      operationId: zone-settings-change-ssl-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_ssl_value'
      responses:
        '200':
          description: Change SSL setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_ssl'
        4XX:
          description: Change SSL setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/ssl_recommender:
    get:
      tags:
      - Zones
      summary: Cloudflare Get SSL/TLS Recommender enrollment setting
      description: 'Enrollment in the SSL/TLS Recommender service which tries to detect and

        recommend (by sending periodic emails) the most secure SSL/TLS setting

        your origin servers support.

        '
      operationId: zone-settings-get-ssl_recommender-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get SSL/TLS Recommender enrollment setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_ssl_recommender'
        4XX:
          description: Get SSL/TLS Recommender enrollment setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change SSL/TLS Recommender enrollment setting
      description: 'Enrollment in the SSL/TLS Recommender service which tries to detect and

        recommend (by sending periodic emails) the most secure SSL/TLS setting

        your origin servers support.

        '
      operationId: zone-settings-change-ssl_recommender-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_ssl_recommender'
      responses:
        '200':
          description: Change SSL/TLS Recommender enrollment setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_ssl_recommender'
        4XX:
          description: Change SSL/TLS Recommender enrollment setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/tls_1_3:
    get:
      tags:
      - Zones
      summary: Cloudflare Get TLS 1.3 setting enabled for a zone
      description: Gets TLS 1.3 setting enabled for a zone.
      operationId: zone-settings-get-tls-1.-3-setting-enabled-for-a-zone
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get TLS 1.3 setting enabled for a zone response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_tls_1_3'
        4XX:
          description: Get TLS 1.3 setting enabled for a zone response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change TLS 1.3 setting
      description: Changes TLS 1.3 setting.
      operationId: zone-settings-change-tls-1.-3-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_tls_1_3_value'
      responses:
        '200':
          description: Change TLS 1.3 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_tls_1_3'
        4XX:
          description: Change TLS 1.3 setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/tls_client_auth:
    get:
      tags:
      - Zones
      summary: Cloudflare Get TLS Client Auth setting
      description: TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).
      operationId: zone-settings-get-tls-client-auth-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get TLS Client Auth setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_tls_client_auth'
        4XX:
          description: Get TLS Client Auth setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change TLS Client Auth setting
      description: TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).
      operationId: zone-settings-change-tls-client-auth-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_tls_client_auth_value'
      responses:
        '200':
          description: Change TLS Client Auth setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_tls_client_auth'
        4XX:
          description: Change TLS Client Auth setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/true_client_ip_header:
    get:
      tags:
      - Zones
      summary: Cloudflare Get True Client IP setting
      description: Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.
      operationId: zone-settings-get-true-client-ip-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get True Client IP setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_true_client_ip_header'
        4XX:
          description: Get True Client IP setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change True Client IP setting
      description: Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.
      operationId: zone-settings-change-true-client-ip-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_true_client_ip_header_value'
      responses:
        '200':
          description: Change True Client IP setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_true_client_ip_header'
        4XX:
          description: Change True Client IP setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/waf:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Web Application Firewall (WAF) setting
      description: The WAF examines HTTP requests to your website.  It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully  to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).
      operationId: zone-settings-get-web-application-firewall-(-waf)-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get Web Application Firewall (WAF) setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_waf'
        4XX:
          description: Get Web Application Firewall (WAF) setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change Web Application Firewall (WAF) setting
      description: The WAF examines HTTP requests to your website.  It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully  to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).
      operationId: zone-settings-change-web-application-firewall-(-waf)-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_waf_value'
      responses:
        '200':
          description: Change Web Application Firewall (WAF) setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_waf'
        4XX:
          description: Change Web Application Firewall (WAF) setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/webp:
    get:
      tags:
      - Zones
      summary: Cloudflare Get WebP setting
      description: When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.
      operationId: zone-settings-get-web-p-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get WebP setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_webp'
        4XX:
          description: Get WebP setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change WebP setting
      description: When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.
      operationId: zone-settings-change-web-p-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_webp_value'
      responses:
        '200':
          description: Change WebP setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_webp'
        4XX:
          description: Change WebP setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/websockets:
    get:
      tags:
      - Zones
      summary: Cloudflare Get WebSockets setting
      description: Gets Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets).
      operationId: zone-settings-get-web-sockets-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      responses:
        '200':
          description: Get WebSockets setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_websockets'
        4XX:
          description: Get WebSockets setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Change WebSockets setting
      description: Changes Websockets setting. For more information about Websockets, please refer to [Using Cloudflare with WebSockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Using-Cloudflare-with-WebSockets).
      operationId: zone-settings-change-web-sockets-setting
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zones_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/zones_websockets_value'
      responses:
        '200':
          description: Change WebSockets setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zones_zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/zones_websockets'
        4XX:
          description: Change WebSockets setting response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zones_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/zaraz/config:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Zaraz configuration
      description: Gets latest Zaraz configuration for a zone. It can be preview or published configuration, whichever was the last updated. Secret variables values will not be included.
      operationId: get-zones-zone_identifier-zaraz-config
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zaraz_identifier'
      responses:
        '200':
          description: Get Zaraz configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_zaraz-config-response'
        4XX:
          description: Get Zaraz configuration response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Zaraz configuration
      description: Updates Zaraz configuration for a zone.
      operationId: put-zones-zone_identifier-zaraz-config
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zaraz_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/zaraz_zaraz-config-body'
      responses:
        '200':
          description: Update Zaraz configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_zaraz-config-response'
        4XX:
          description: Update Zaraz configuration response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/zaraz/default:
    get:
      tags:
      - Zones
      summary: Cloudflare Get default Zaraz configuration
      description: Gets default Zaraz configuration for a zone.
      operationId: get-zones-zone_identifier-zaraz-default
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zaraz_identifier'
      responses:
        '200':
          description: Get Zaraz default configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_zaraz-config-response'
        4XX:
          description: Get Zaraz default configuration response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/zaraz/export:
    get:
      tags:
      - Zones
      summary: Cloudflare Export Zaraz configuration
      description: Exports full current published Zaraz configuration for a zone, secret variables included.
      operationId: get-zones-zone_identifier-zaraz-export
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zaraz_identifier'
      responses:
        '200':
          description: Get Zaraz configuration response
          headers:
            Content-Disposition:
              parameter:
                schema:
                  type: string
                example: attachment; filename=zaraz-2023-11-10-23-00.json
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_zaraz-config-return'
        4XX:
          description: Get Zaraz configuration response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/zaraz/history:
    get:
      tags:
      - Zones
      summary: Cloudflare List Zaraz historical configuration records
      description: Lists a history of published Zaraz configuration records for a zone.
      operationId: get-zones-zone_identifier-zaraz-history
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zaraz_identifier'
      - name: offset
        in: query
        description: Ordinal number to start listing the results with. Default value is 0.
        schema:
          type: integer
          minimum: 0
        example: 0
      - name: limit
        in: query
        description: Maximum amount of results to list. Default value is 10.
        schema:
          type: integer
          minimum: 1
        example: 10
      - name: sortField
        in: query
        description: The field to sort by. Default is updated_at.
        schema:
          type: string
          enum:
          - id
          - user_id
          - description
          - created_at
          - updated_at
        example: updated_at
      - name: sortOrder
        in: query
        description: Sorting order. Default is DESC.
        schema:
          type: string
          enum:
          - DESC
          - ASC
        example: DESC
      responses:
        '200':
          description: List Zaraz historical configuration records response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_zaraz-history-response'
        4XX:
          description: List Zaraz historical configuration records failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Restore Zaraz historical configuration by ID
      description: Restores a historical published Zaraz configuration by ID for a zone.
      operationId: put-zones-zone_identifier-zaraz-history
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zaraz_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: integer
              description: ID of the Zaraz configuration to restore.
              example: 12345
              minimum: 1
      responses:
        '200':
          description: Restore Zaraz historical configuration by ID response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_zaraz-config-response'
        4XX:
          description: Restore Zaraz historical configuration by ID failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/zaraz/history/configs:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Zaraz historical configurations by ID(s)
      description: Gets a history of published Zaraz configurations by ID(s) for a zone.
      operationId: get-zones-zone_identifier-zaraz-config-history
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zaraz_identifier'
      - name: ids
        in: query
        description: Comma separated list of Zaraz configuration IDs
        style: form
        explode: false
        required: true
        schema:
          type: array
          items:
            type: integer
        example:
        - 12345
        - 23456
      responses:
        '200':
          description: Get Zaraz historical configurations by ID(s) response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_zaraz-config-history-response'
        4XX:
          description: Get Zaraz historical configurations by ID(s) failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/zaraz/publish:
    post:
      tags:
      - Zones
      summary: Cloudflare Publish Zaraz preview configuration
      description: Publish current Zaraz preview configuration for a zone.
      operationId: post-zones-zone_identifier-zaraz-publish
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zaraz_identifier'
      requestBody:
        content:
          application/json:
            schema:
              type: string
              description: Zaraz configuration description.
              example: Config with enabled ecommerce tracking
      responses:
        '200':
          description: Update Zaraz workflow response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zaraz_api-response-common'
                - properties:
                    result:
                      type: string
                      example: Config has been published successfully
        4XX:
          description: Update Zaraz workflow response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/settings/zaraz/workflow:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Zaraz workflow
      description: Gets Zaraz workflow for a zone.
      operationId: get-zones-zone_identifier-zaraz-workflow
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zaraz_identifier'
      responses:
        '200':
          description: Get Zaraz workflow response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_zaraz-workflow-response'
        4XX:
          description: Get Zaraz workflow response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Zaraz workflow
      description: Updates Zaraz workflow for a zone.
      operationId: put-zones-zone_identifier-zaraz-workflow
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zaraz_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/zaraz_zaraz-workflow'
      responses:
        '200':
          description: Update Zaraz workflow response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_zaraz-workflow-response'
        4XX:
          description: Update Zaraz workflow response failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zaraz_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/speed_api/availabilities:
    get:
      tags:
      - Zones
      summary: Cloudflare Get quota and availability
      description: Retrieves quota for all plans, as well as the current zone quota.
      operationId: speed-get-availabilities
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_identifier'
      responses:
        '200':
          description: Page test availability
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_availabilities-response'
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/speed_api/pages:
    get:
      tags:
      - Zones
      summary: Cloudflare List tested webpages
      description: Lists all webpages which have been tested.
      operationId: speed-list-pages
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_identifier'
      responses:
        '200':
          description: List of pages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_pages-response-collection'
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/speed_api/pages/{url}/tests:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete all page tests
      description: Deletes all tests for a specific webpage from a specific region. Deleted tests are still counted as part of the quota.
      operationId: speed-delete-tests
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_identifier'
      - name: url
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_url'
      - name: region
        in: query
        schema:
          $ref: '#/components/schemas/observatory_region'
      responses:
        '200':
          description: Number of deleted tests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_count-response'
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare List page test history
      description: Test history (list of tests) for a specific webpage.
      operationId: speed-list-test-history
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_identifier'
      - name: url
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_url'
      - name: page
        in: query
        schema:
          type: integer
          example: 1
      - name: per_page
        in: query
        schema:
          type: integer
          example: 20
          minimum: 5
          maximum: 50
      - name: region
        in: query
        schema:
          $ref: '#/components/schemas/observatory_region'
      responses:
        '200':
          description: List of test history for a page
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_page-test-response-collection'
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Start page test
      description: Starts a test for a specific webpage, in a specific region.
      operationId: speed-create-test
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_identifier'
      - name: url
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_url'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                region:
                  $ref: '#/components/schemas/observatory_region'
      responses:
        '200':
          description: Page test details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_page-test-response-single'
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/speed_api/pages/{url}/tests/{test_id}:
    get:
      tags:
      - Zones
      summary: Cloudflare Get a page test result
      description: Retrieves the result of a specific test.
      operationId: speed-get-test
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_identifier'
      - name: url
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_url'
      - name: test_id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Page test result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_page-test-response-single'
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/speed_api/pages/{url}/trend:
    get:
      tags:
      - Zones
      summary: Cloudflare List core web vital metrics trend
      description: Lists the core web vital metrics trend over time for a specific page.
      operationId: speed-list-page-trend
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_identifier'
      - name: url
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_url'
      - name: region
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/observatory_region'
      - name: deviceType
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/observatory_device_type'
      - name: start
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/observatory_timestamp'
      - name: end
        in: query
        schema:
          $ref: '#/components/schemas/observatory_timestamp'
      - name: tz
        in: query
        description: The timezone of the start and end timestamps.
        required: true
        schema:
          type: string
        example: America/Chicago
      - name: metrics
        in: query
        description: A comma-separated list of metrics to include in the results.
        required: true
        schema:
          type: string
          example: performanceScore,ttfb,fcp,si,lcp,tti,tbt,cls
      responses:
        '200':
          description: Page trend
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_trend-response'
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/speed_api/schedule/{url}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete scheduled page test
      description: Deletes a scheduled test for a page.
      operationId: speed-delete-test-schedule
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_identifier'
      - name: url
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_url'
      - name: region
        in: query
        schema:
          $ref: '#/components/schemas/observatory_region'
      responses:
        '200':
          description: Number of deleted tests
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_count-response'
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get a page test schedule
      description: Retrieves the test schedule for a page in a specific region.
      operationId: speed-get-scheduled-test
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_identifier'
      - name: url
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_url'
      - name: region
        in: query
        schema:
          $ref: '#/components/schemas/observatory_region'
      responses:
        '200':
          description: Page test schedule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_schedule-response-single'
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create scheduled page test
      description: Creates a scheduled test for a page.
      operationId: speed-create-scheduled-test
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_identifier'
      - name: url
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/observatory_url'
      - name: region
        in: query
        schema:
          $ref: '#/components/schemas/observatory_region'
      responses:
        '200':
          description: Page test schedule
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_create-schedule-response'
        4XX:
          description: Failure response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/observatory_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/ssl/analyze:
    post:
      tags:
      - Zones
      summary: Cloudflare Analyze Certificate
      description: Returns the set of hostnames, the signature algorithm, and the expiration date of the certificate.
      operationId: analyze-certificate-analyze-certificate
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                bundle_method:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_bundle_method'
                certificate:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate'
      responses:
        '200':
          description: Analyze Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_analyze_response'
        4XX:
          description: Analyze Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_analyze_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/ssl/certificate_packs:
    get:
      tags:
      - Zones
      summary: Cloudflare List Certificate Packs
      description: For a given zone, list all active certificate packs.
      operationId: certificate-packs-list-certificate-packs
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: status
        in: query
        schema:
          description: Include Certificate Packs of all statuses, not just active ones.
          enum:
          - all
          example: all
      responses:
        '200':
          description: List Certificate Packs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_pack_response_collection'
        4XX:
          description: List Certificate Packs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_pack_response_collection'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/ssl/certificate_packs/{certificate_pack_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Advanced Certificate Manager Certificate Pack
      description: For a given zone, delete an advanced certificate pack.
      operationId: certificate-packs-delete-advanced-certificate-manager-certificate-pack
      parameters:
      - name: certificate_pack_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Advanced Certificate Manager Certificate Pack response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_delete_advanced_certificate_pack_response_single'
        4XX:
          description: Delete Advanced Certificate Manager Certificate Pack response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_delete_advanced_certificate_pack_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get Certificate Pack
      description: For a given zone, get a certificate pack.
      operationId: certificate-packs-get-certificate-pack
      parameters:
      - name: certificate_pack_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Get Certificate Pack response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_pack_response_single'
        4XX:
          description: Get Certificate Pack response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_pack_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Restart Validation for Advanced Certificate Manager Certificate Pack
      description: For a given zone, restart validation for an advanced certificate pack.  This is only a validation operation for a Certificate Pack in a validation_timed_out status.
      operationId: certificate-packs-restart-validation-for-advanced-certificate-manager-certificate-pack
      parameters:
      - name: certificate_pack_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Restart Validation for Advanced Certificate Manager Certificate Pack response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_certificate_pack_response_single'
        4XX:
          description: Restart Validation for Advanced Certificate Manager Certificate Pack response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_certificate_pack_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/ssl/certificate_packs/order:
    post:
      tags:
      - Zones
      summary: Cloudflare Order Advanced Certificate Manager Certificate Pack
      description: For a given zone, order an advanced certificate pack.
      operationId: certificate-packs-order-advanced-certificate-manager-certificate-pack
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - type
              - hosts
              - validation_method
              - validity_days
              - certificate_authority
              properties:
                certificate_authority:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_authority'
                cloudflare_branding:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_cloudflare_branding'
                hosts:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hosts'
                type:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_type'
                validation_method:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_method'
                validity_days:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_validity_days'
      responses:
        '200':
          description: Order Advanced Certificate Manager Certificate Pack response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_certificate_pack_response_single'
        4XX:
          description: Order Advanced Certificate Manager Certificate Pack response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_certificate_pack_response_single'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/ssl/certificate_packs/quota:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Certificate Pack Quotas
      description: For a given zone, list certificate pack quotas.
      operationId: certificate-packs-get-certificate-pack-quotas
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Get Certificate Pack Quotas response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_pack_quota_response'
        4XX:
          description: Get Certificate Pack Quotas response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_pack_quota_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/ssl/universal/settings:
    get:
      tags:
      - Zones
      summary: Cloudflare Universal SSL Settings Details
      description: Get Universal SSL Settings for a Zone.
      operationId: universal-ssl-settings-for-a-zone-universal-ssl-settings-details
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      responses:
        '200':
          description: Universal SSL Settings Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_universal_settings_response'
        4XX:
          description: Universal SSL Settings Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_universal_settings_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Edit Universal SSL Settings
      description: Patch Universal SSL Settings for a Zone.
      operationId: universal-ssl-settings-for-a-zone-edit-universal-ssl-settings
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_universal'
      responses:
        '200':
          description: Edit Universal SSL Settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_universal_settings_response'
        4XX:
          description: Edit Universal SSL Settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_universal_settings_response'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/ssl/verification:
    get:
      tags:
      - Zones
      summary: Cloudflare SSL Verification Details
      description: Get SSL Verification Info for a Zone.
      operationId: ssl-verification-ssl-verification-details
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      - name: retry
        in: query
        schema:
          description: Immediately retry SSL Verification.
          enum:
          - true
          example: true
      responses:
        '200':
          description: SSL Verification Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_verification_response_collection'
        4XX:
          description: SSL Verification Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_verification_response_collection'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/ssl/verification/{certificate_pack_id}:
    patch:
      tags:
      - Zones
      summary: Cloudflare Edit SSL Certificate Pack Validation Method
      description: Edit SSL validation method for a certificate pack. A PATCH request will request an immediate validation check on any certificate, and return the updated status. If a validation method is provided, the validation will be immediately attempted using that method.
      operationId: ssl-verification-edit-ssl-certificate-pack-validation-method
      parameters:
      - name: certificate_pack_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_cert_pack_uuid'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-validation_method'
      responses:
        '200':
          description: Edit SSL Certificate Pack Validation Method response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_validation_method_response_collection'
        4XX:
          description: Edit SSL Certificate Pack Validation Method response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl_validation_method_response_collection'
                - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/url_normalization:
    get:
      tags:
      - Zones
      summary: Cloudflare Get URL normalization settings
      description: Fetches the current URL normalization settings.
      operationId: url-normalization-get-url-normalization-settings
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_identifier'
      responses:
        '200':
          description: Get URL normalization settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_schemas-response_model'
        4XX:
          description: Get URL normalization settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_schemas-response_model'
                - $ref: '#/components/schemas/rulesets_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update URL normalization settings
      description: Updates the URL normalization settings.
      operationId: url-normalization-update-url-normalization-settings
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/rulesets_schemas-request_model'
      responses:
        '200':
          description: Update URL normalization settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_schemas-response_model'
        4XX:
          description: Update URL normalization settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_schemas-response_model'
                - $ref: '#/components/schemas/rulesets_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_id}/workers/filters:
    get:
      tags:
      - Zones
      summary: Cloudflare List Filters
      operationId: worker-filters-(-deprecated)-list-filters
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      responses:
        '200':
          description: List Filters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_filter-response-collection'
        4XX:
          description: List Filters response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_filter-response-collection'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
      deprecated: true
      security:
      - api_token: []
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Filter
      operationId: worker-filters-(-deprecated)-create-filter
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_filter-no-id'
      responses:
        '200':
          description: Create Filter response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-single-id'
        4XX:
          description: Create Filter response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_api-response-single-id'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
      deprecated: true
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/workers/filters/{filter_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Filter
      operationId: worker-filters-(-deprecated)-delete-filter
      parameters:
      - name: filter_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Filter response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-single-id'
        4XX:
          description: Delete Filter response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_api-response-single-id'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
      deprecated: true
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Filter
      operationId: worker-filters-(-deprecated)-update-filter
      parameters:
      - name: filter_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_filter-no-id'
      responses:
        '200':
          description: Update Filter response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_filter-response-single'
        4XX:
          description: Update Filter response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_filter-response-single'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
      deprecated: true
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/workers/routes:
    get:
      tags:
      - Zones
      summary: Cloudflare List Routes
      description: Returns routes for a zone.
      operationId: worker-routes-list-routes
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      responses:
        '200':
          description: List Routes response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_route-response-collection'
        4XX:
          description: List Routes response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_route-response-collection'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Route
      description: Creates a route that maps a URL pattern to a Worker.
      operationId: worker-routes-create-route
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_route-no-id'
      responses:
        '200':
          description: Create Route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-single'
        4XX:
          description: Create Route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_api-response-single'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/workers/routes/{route_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Route
      description: Deletes a route.
      operationId: worker-routes-delete-route
      parameters:
      - name: route_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_api-response-single'
        4XX:
          description: Delete Route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_api-response-single'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get Route
      description: Returns information about a route, including URL pattern and Worker.
      operationId: worker-routes-get-route
      parameters:
      - name: route_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      responses:
        '200':
          description: Get Route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_route-response-single'
        4XX:
          description: Get Route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_route-response-single'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Route
      description: Updates the URL pattern or Worker associated with a route.
      operationId: worker-routes-update-route
      parameters:
      - name: route_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/workers_route-no-id'
      responses:
        '200':
          description: Update Route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_route-response-single'
        4XX:
          description: Update Route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_route-response-single'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/workers/script:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Worker
      description: Delete your Worker. This call has no response body on a successful delete.
      operationId: worker-script-(-deprecated)-delete-worker
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Worker response.
          content:
            application/json: {}
        4XX:
          description: Delete Worker response failure.
          content:
            application/json: {}
      deprecated: true
      security:
      - api_token: []
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Download Worker
      description: Fetch raw script content for your worker. Note this is the original script content, not JSON encoded.
      operationId: worker-script-(-deprecated)-download-worker
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      responses:
        '200':
          description: Download Worker response
          content:
            undefined:
              schema:
                example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
        4XX:
          description: Download Worker response failure
          content:
            undefined:
              schema:
                example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
      deprecated: true
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Upload Worker
      description: Upload a worker, or a new version of a worker.
      operationId: worker-script-(-deprecated)-upload-worker
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      requestBody:
        required: true
        content:
          application/javascript:
            schema:
              example: addEventListener('fetch', event => { event.respondWith(fetch(event.request)) })
      responses:
        '200':
          description: Upload Worker response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/workers_schemas-script-response-single'
        4XX:
          description: Upload Worker response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_schemas-script-response-single'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
      deprecated: true
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_id}/workers/script/bindings:
    get:
      tags:
      - Zones
      summary: Cloudflare List Bindings
      description: List the bindings for a Workers script.
      operationId: worker-binding-(-deprecated)-list-bindings
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/workers_identifier'
      responses:
        '200':
          description: List Bindings response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/workers_api-response-common'
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/workers_schemas-binding'
        4XX:
          description: List Bindings response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/workers_api-response-common'
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          $ref: '#/components/schemas/workers_schemas-binding'
                - $ref: '#/components/schemas/workers_api-response-common-failure'
      deprecated: true
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/analytics/colos:
    get:
      tags:
      - Zones
      summary: Cloudflare Get analytics by Co-locations
      description: 'This view provides a breakdown of analytics data by datacenter. Note: This is available to Enterprise customers only.'
      operationId: zone-analytics-(-deprecated)-get-analytics-by-co-locations
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_identifier'
      - name: until
        in: query
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_until'
      - name: since
        in: query
        schema:
          anyOf:
          - type: string
          - type: integer
          description: 'The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.


            Ranges that the Cloudflare web application provides will provide the following period length for each point:

            - Last 60 minutes (from -59 to -1): 1 minute resolution

            - Last 7 hours (from -419 to -60): 15 minutes resolution

            - Last 15 hours (from -899 to -420): 30 minutes resolution

            - Last 72 hours (from -4320 to -900): 1 hour resolution

            - Older than 3 days (-525600 to -4320): 1 day resolution.'
          default: -10080
          example: '2015-01-01T12:23:00Z'
      - name: continuous
        in: query
        schema:
          type: boolean
          description: 'When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data.


            The API response _may not represent the requested time window_.'
          default: true
      responses:
        '200':
          description: Get analytics by Co-locations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data-zone-analytics-api_colo_response'
        4XX:
          description: Get analytics by Co-locations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/data-zone-analytics-api_colo_response'
                - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure'
      deprecated: true
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_identifier}/analytics/dashboard:
    get:
      tags:
      - Zones
      summary: Cloudflare Get dashboard
      description: The dashboard view provides both totals and timeseries data for the given zone and time period across the entire Cloudflare network.
      operationId: zone-analytics-(-deprecated)-get-dashboard
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_identifier'
      - name: until
        in: query
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_until'
      - name: since
        in: query
        schema:
          anyOf:
          - type: string
          - type: integer
          description: 'The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.


            Ranges that the Cloudflare web application provides will provide the following period length for each point:

            - Last 60 minutes (from -59 to -1): 1 minute resolution

            - Last 7 hours (from -419 to -60): 15 minutes resolution

            - Last 15 hours (from -899 to -420): 30 minutes resolution

            - Last 72 hours (from -4320 to -900): 1 hour resolution

            - Older than 3 days (-525600 to -4320): 1 day resolution.'
          default: -10080
          example: '2015-01-01T12:23:00Z'
      - name: continuous
        in: query
        schema:
          type: boolean
          description: 'When set to true, the API will move the requested time window backward, until it finds a region with completely aggregated data.


            The API response _may not represent the requested time window_.'
          default: true
      responses:
        '200':
          description: Get dashboard response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data-zone-analytics-api_dashboard_response'
        4XX:
          description: Get dashboard response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/data-zone-analytics-api_dashboard_response'
                - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure'
      deprecated: true
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_identifier}/available_plans:
    get:
      tags:
      - Zones
      summary: Cloudflare List Available Plans
      description: Lists available plans the zone can subscribe to.
      operationId: zone-rate-plan-list-available-plans
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bill-subs-api_identifier'
      responses:
        '200':
          description: List Available Plans response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bill-subs-api_api-response-collection'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/bill-subs-api_available-rate-plan'
        4XX:
          description: List Available Plans response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/bill-subs-api_api-response-collection'
                  - properties:
                      result:
                        type: array
                        items:
                          $ref: '#/components/schemas/bill-subs-api_available-rate-plan'
                - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_identifier}/available_plans/{plan_identifier}:
    get:
      tags:
      - Zones
      summary: Cloudflare Available Plan Details
      description: Details of the available plan that the zone can subscribe to.
      operationId: zone-rate-plan-available-plan-details
      parameters:
      - name: plan_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bill-subs-api_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bill-subs-api_identifier'
      responses:
        '200':
          description: Available Plan Details response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bill-subs-api_api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/bill-subs-api_available-rate-plan'
        4XX:
          description: Available Plan Details response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/bill-subs-api_api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/bill-subs-api_available-rate-plan'
                - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_identifier}/available_rate_plans:
    get:
      tags:
      - Zones
      summary: Cloudflare List Available Rate Plans
      description: Lists all rate plans the zone can subscribe to.
      operationId: zone-rate-plan-list-available-rate-plans
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bill-subs-api_identifier'
      responses:
        '200':
          description: List Available Rate Plans response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bill-subs-api_plan_response_collection'
        4XX:
          description: List Available Rate Plans response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bill-subs-api_plan_response_collection'
                - $ref: '#/components/schemas/bill-subs-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_identifier}/custom_pages:
    get:
      tags:
      - Zones
      summary: Cloudflare List custom pages
      description: Fetches all the custom pages at the zone level.
      operationId: custom-pages-for-a-zone-list-custom-pages
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-pages_identifier'
      responses:
        '200':
          description: List custom pages response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-pages_custom_pages_response_collection'
        4xx:
          description: List custom pages response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-pages_custom_pages_response_collection'
                - $ref: '#/components/schemas/custom-pages_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/custom_pages/{identifier}:
    get:
      tags:
      - Zones
      summary: Cloudflare Get a custom page
      description: Fetches the details of a custom page.
      operationId: custom-pages-for-a-zone-get-a-custom-page
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-pages_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-pages_identifier'
      responses:
        '200':
          description: Get a custom page response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
        4xx:
          description: Get a custom page response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
                - $ref: '#/components/schemas/custom-pages_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update a custom page
      description: Updates the configuration of an existing custom page.
      operationId: custom-pages-for-a-zone-update-a-custom-page
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-pages_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-pages_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - url
              - state
              properties:
                state:
                  $ref: '#/components/schemas/custom-pages_state'
                url:
                  $ref: '#/components/schemas/custom-pages_url'
      responses:
        '200':
          description: Update a custom page response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
        4xx:
          description: Update a custom page response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom-pages_custom_pages_response_single'
                - $ref: '#/components/schemas/custom-pages_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/email/routing:
    get:
      tags:
      - Zones
      summary: Cloudflare Get Email Routing settings
      description: Get information about the settings for your Email Routing zone.
      operationId: email-routing-settings-get-email-routing-settings
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_identifier'
      responses:
        '200':
          description: Get Email Routing settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_email_settings_response_single'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/email/routing/disable:
    post:
      tags:
      - Zones
      summary: Cloudflare Disable Email Routing
      description: Disable your Email Routing zone. Also removes additional MX records previously required for Email Routing to work.
      operationId: email-routing-settings-disable-email-routing
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Disable Email Routing response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_email_settings_response_single'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/email/routing/dns:
    get:
      tags:
      - Zones
      summary: Cloudflare Email Routing - DNS settings
      description: Show the DNS records needed to configure your Email Routing zone.
      operationId: email-routing-settings-email-routing-dns-settings
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_identifier'
      responses:
        '200':
          description: Email Routing - DNS settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_dns_settings_response_collection'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/email/routing/enable:
    post:
      tags:
      - Zones
      summary: Cloudflare Enable Email Routing
      description: Enable you Email Routing zone. Add and lock the necessary MX and SPF records.
      operationId: email-routing-settings-enable-email-routing
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Enable Email Routing response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_email_settings_response_single'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/email/routing/rules:
    get:
      tags:
      - Zones
      summary: Cloudflare List routing rules
      description: Lists existing routing rules.
      operationId: email-routing-routing-rules-list-routing-rules
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_identifier'
      - name: page
        in: query
        schema:
          type: number
          description: Page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: Maximum number of results per page.
          default: 20
          minimum: 5
          maximum: 50
      - name: enabled
        in: query
        schema:
          type: boolean
          description: Filter by enabled routing rules.
          enum:
          - true
          - false
          example: true
      responses:
        '200':
          description: List routing rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_rules_response_collection'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create routing rule
      description: Rules consist of a set of criteria for matching emails (such as an email being sent to a specific custom email address) plus a set of actions to take on the email (like forwarding it to a specific destination address).
      operationId: email-routing-routing-rules-create-routing-rule
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/email_create_rule_properties'
      responses:
        '200':
          description: Create routing rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_rule_response_single'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/email/routing/rules/{rule_identifier}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete routing rule
      description: Delete a specific routing rule.
      operationId: email-routing-routing-rules-delete-routing-rule
      parameters:
      - name: rule_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_rule_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_identifier'
      responses:
        '200':
          description: Delete routing rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_rule_response_single'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get routing rule
      description: Get information for a specific routing rule already created.
      operationId: email-routing-routing-rules-get-routing-rule
      parameters:
      - name: rule_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_rule_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_identifier'
      responses:
        '200':
          description: Get routing rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_rule_response_single'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update routing rule
      description: Update actions and matches, or enable/disable specific routing rules.
      operationId: email-routing-routing-rules-update-routing-rule
      parameters:
      - name: rule_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_rule_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/email_update_rule_properties'
      responses:
        '200':
          description: Update routing rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_rule_response_single'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/email/routing/rules/catch_all:
    get:
      tags:
      - Zones
      summary: Cloudflare Get catch-all rule
      description: Get information on the default catch-all routing rule.
      operationId: email-routing-routing-rules-get-catch-all-rule
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_identifier'
      responses:
        '200':
          description: Get catch-all rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_catch_all_rule_response_single'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update catch-all rule
      description: Enable or disable catch-all routing rule, or change action to forward to specific destination address.
      operationId: email-routing-routing-rules-update-catch-all-rule
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/email_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/email_update_catch_all_rule_properties'
      responses:
        '200':
          description: Update catch-all rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email_catch_all_rule_response_single'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/filters:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete filters
      description: Deletes one or more existing filters.
      operationId: filters-delete-filters
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  $ref: '#/components/schemas/legacy-jhs_filters_components-schemas-id'
      responses:
        '200':
          description: Delete filters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_filter-delete-response-collection'
        4xx:
          description: Delete filters response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_filter-delete-response-collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zones
      summary: Cloudflare List filters
      description: Fetches filters in a zone. You can filter the results using several optional parameters.
      operationId: filters-list-filters
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: paused
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_filters_components-schemas-paused'
      - name: expression
        in: query
        schema:
          type: string
          description: A case-insensitive string to find in the expression.
          example: php
      - name: description
        in: query
        schema:
          type: string
          description: A case-insensitive string to find in the description.
          example: browsers
      - name: ref
        in: query
        schema:
          type: string
          description: The filter ref (a short reference tag) to search for. Must be an exact match.
          example: FIL-100
      - name: page
        in: query
        schema:
          type: number
          description: Page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: Number of filters per page.
          default: 25
          minimum: 5
          maximum: 100
      - name: id
        in: query
        schema:
          type: string
          description: The unique identifier of the filter.
          example: 372e67954025e0ba6aaa6d586b9e0b61
          readOnly: true
          minLength: 32
          maxLength: 32
      responses:
        '200':
          description: List filters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_schemas-filter-response-collection'
        4xx:
          description: List filters response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_schemas-filter-response-collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create filters
      description: Creates one or more filters.
      operationId: filters-create-filters
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - expression
      responses:
        '200':
          description: Create filters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_schemas-filter-response-collection'
        4xx:
          description: Create filters response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_schemas-filter-response-collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update filters
      description: Updates one or more existing filters.
      operationId: filters-update-filters
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        '200':
          description: Update filters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_schemas-filter-response-collection'
        4xx:
          description: Update filters response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_schemas-filter-response-collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/filters/{id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a filter
      description: Deletes an existing filter.
      operationId: filters-delete-a-filter
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_filters_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete a filter response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_filter-delete-response-single'
        4xx:
          description: Delete a filter response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_filter-delete-response-single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get a filter
      description: Fetches the details of a filter.
      operationId: filters-get-a-filter
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_filters_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      responses:
        '200':
          description: Get a filter response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_schemas-filter-response-single'
        4xx:
          description: Get a filter response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_schemas-filter-response-single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update a filter
      description: Updates an existing filter.
      operationId: filters-update-a-filter
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_filters_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        '200':
          description: Update a filter response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_schemas-filter-response-single'
        4xx:
          description: Update a filter response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_schemas-filter-response-single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/lockdowns:
    get:
      tags:
      - Zones
      summary: Cloudflare List Zone Lockdown rules
      description: Fetches Zone Lockdown rules. You can filter the results using several optional parameters.
      operationId: zone-lockdown-list-zone-lockdown-rules
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: page
        in: query
        schema:
          type: number
          description: Page number of paginated results.
          default: 1
          minimum: 1
      - name: description
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_schemas-description_search'
      - name: modified_on
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_components-schemas-modified_on'
      - name: ip
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_ip_search'
      - name: priority
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_lockdowns_components-schemas-priority'
      - name: uri_search
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_uri_search'
      - name: ip_range_search
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_ip_range_search'
      - name: per_page
        in: query
        schema:
          type: number
          description: The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.
          default: 20
          minimum: 1
          maximum: 1000
      - name: created_on
        in: query
        schema:
          type: string
          format: date-time
          description: The timestamp of when the rule was created.
          example: '2014-01-01T05:20:00.12345Z'
          readOnly: true
      - name: description_search
        in: query
        schema:
          type: string
          description: A string to search for in the description of existing rules.
          example: endpoints
      - name: ip_search
        in: query
        schema:
          type: string
          description: A single IP address to search for in existing rules.
          example: 1.2.3.4
      responses:
        '200':
          description: List Zone Lockdown rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_zonelockdown_response_collection'
        4xx:
          description: List Zone Lockdown rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_zonelockdown_response_collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create a Zone Lockdown rule
      description: Creates a new Zone Lockdown rule.
      operationId: zone-lockdown-create-a-zone-lockdown-rule
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - urls
              - configurations
      responses:
        '200':
          description: Create a Zone Lockdown rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_zonelockdown_response_single'
        4xx:
          description: Create a Zone Lockdown rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_zonelockdown_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/lockdowns/{id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a Zone Lockdown rule
      description: Deletes an existing Zone Lockdown rule.
      operationId: zone-lockdown-delete-a-zone-lockdown-rule
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_lockdowns_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete a Zone Lockdown rule response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    properties:
                      id:
                        $ref: '#/components/schemas/legacy-jhs_lockdowns_components-schemas-id'
        4xx:
          description: Delete a Zone Lockdown rule response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/legacy-jhs_lockdowns_components-schemas-id'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get a Zone Lockdown rule
      description: Fetches the details of a Zone Lockdown rule.
      operationId: zone-lockdown-get-a-zone-lockdown-rule
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_lockdowns_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      responses:
        '200':
          description: Get a Zone Lockdown rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_zonelockdown_response_single'
        4xx:
          description: Get a Zone Lockdown rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_zonelockdown_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update a Zone Lockdown rule
      description: Updates an existing Zone Lockdown rule.
      operationId: zone-lockdown-update-a-zone-lockdown-rule
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_lockdowns_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - urls
              - configurations
      responses:
        '200':
          description: Update a Zone Lockdown rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_zonelockdown_response_single'
        4xx:
          description: Update a Zone Lockdown rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_zonelockdown_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/rules:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete firewall rules
      description: Deletes existing firewall rules.
      operationId: firewall-rules-delete-firewall-rules
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  $ref: '#/components/schemas/legacy-jhs_firewall-rules_components-schemas-id'
      responses:
        '200':
          description: Delete firewall rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_filter-rules-response-collection-delete'
        4xx:
          description: Delete firewall rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_filter-rules-response-collection-delete'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zones
      summary: Cloudflare List firewall rules
      description: Fetches firewall rules in a zone. You can filter the results using several optional parameters.
      operationId: firewall-rules-list-firewall-rules
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: description
        in: query
        schema:
          type: string
          description: A case-insensitive string to find in the description.
          example: mir
      - name: action
        in: query
        schema:
          type: string
          description: The action to search for. Must be an exact match.
          example: block
      - name: page
        in: query
        schema:
          type: number
          description: Page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: Number of firewall rules per page.
          default: 25
          minimum: 5
          maximum: 100
      - name: id
        in: query
        schema:
          type: string
          description: The unique identifier of the firewall rule.
          example: 372e67954025e0ba6aaa6d586b9e0b60
          readOnly: true
          maxLength: 32
      - name: paused
        in: query
        schema:
          type: boolean
          description: When true, indicates that the firewall rule is currently paused.
          example: false
      responses:
        '200':
          description: List firewall rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_filter-rules-response-collection'
        4xx:
          description: List firewall rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_filter-rules-response-collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Update priority of firewall rules
      description: Updates the priority of existing firewall rules.
      operationId: firewall-rules-update-priority-of-firewall-rules
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        '200':
          description: Update priority of firewall rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_filter-rules-response-collection'
        4xx:
          description: Update priority of firewall rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_filter-rules-response-collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create firewall rules
      description: Create one or more firewall rules.
      operationId: firewall-rules-create-firewall-rules
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - filter
              - action
      responses:
        '200':
          description: Create firewall rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_filter-rules-response-collection'
        4xx:
          description: Create firewall rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_filter-rules-response-collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update firewall rules
      description: Updates one or more existing firewall rules.
      operationId: firewall-rules-update-firewall-rules
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        '200':
          description: Update firewall rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_filter-rules-response-collection'
        4xx:
          description: Update firewall rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_filter-rules-response-collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/rules/{id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a firewall rule
      description: Deletes an existing firewall rule.
      operationId: firewall-rules-delete-a-firewall-rule
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_firewall-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                delete_filter_if_unused:
                  $ref: '#/components/schemas/legacy-jhs_delete_filter_if_unused'
      responses:
        '200':
          description: Delete a firewall rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_filter-rules-single-response-delete'
        4xx:
          description: Delete a firewall rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_filter-rules-single-response-delete'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get a firewall rule
      description: Fetches the details of a firewall rule.
      operationId: firewall-rules-get-a-firewall-rule
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_firewall-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: id
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_firewall-rules_components-schemas-id'
      responses:
        '200':
          description: Get a firewall rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_filter-rules-single-response'
        4xx:
          description: Get a firewall rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_filter-rules-single-response'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Update priority of a firewall rule
      description: Updates the priority of an existing firewall rule.
      operationId: firewall-rules-update-priority-of-a-firewall-rule
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_firewall-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        '200':
          description: Update priority of a firewall rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_filter-rules-response-collection'
        4xx:
          description: Update priority of a firewall rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_filter-rules-response-collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update a firewall rule
      description: Updates an existing firewall rule.
      operationId: firewall-rules-update-a-firewall-rule
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_firewall-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
              - filter
              - action
      responses:
        '200':
          description: Update a firewall rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_filter-rules-single-response'
        4xx:
          description: Update a firewall rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_filter-rules-single-response'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/ua_rules:
    get:
      tags:
      - Zones
      summary: Cloudflare List User Agent Blocking rules
      description: Fetches User Agent Blocking rules in a zone. You can filter the results using several optional parameters.
      operationId: user-agent-blocking-rules-list-user-agent-blocking-rules
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: page
        in: query
        schema:
          type: number
          description: Page number of paginated results.
          default: 1
          minimum: 1
      - name: description
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_description_search'
      - name: description_search
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_description_search'
      - name: per_page
        in: query
        schema:
          type: number
          description: The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.
          default: 20
          minimum: 1
          maximum: 1000
      - name: ua_search
        in: query
        schema:
          type: string
          description: A string to search for in the user agent values of existing rules.
          example: Safari
      responses:
        '200':
          description: List User Agent Blocking rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_firewalluablock_response_collection'
        4xx:
          description: List User Agent Blocking rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_firewalluablock_response_collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create a User Agent Blocking rule
      description: Creates a new User Agent Blocking rule in a zone.
      operationId: user-agent-blocking-rules-create-a-user-agent-blocking-rule
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - mode
              - configuration
      responses:
        '200':
          description: Create a User Agent Blocking rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_firewalluablock_response_single'
        4xx:
          description: Create a User Agent Blocking rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_firewalluablock_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/ua_rules/{id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a User Agent Blocking rule
      description: Deletes an existing User Agent Blocking rule.
      operationId: user-agent-blocking-rules-delete-a-user-agent-blocking-rule
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_ua-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete a User Agent Blocking rule response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_firewalluablock_response_single'
                - type: object
                  properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/legacy-jhs_ua-rules_components-schemas-id'
        4xx:
          description: Delete a User Agent Blocking rule response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/legacy-jhs_firewalluablock_response_single'
                  - type: object
                    properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/legacy-jhs_ua-rules_components-schemas-id'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get a User Agent Blocking rule
      description: Fetches the details of a User Agent Blocking rule.
      operationId: user-agent-blocking-rules-get-a-user-agent-blocking-rule
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_ua-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      responses:
        '200':
          description: Get a User Agent Blocking rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_firewalluablock_response_single'
        4xx:
          description: Get a User Agent Blocking rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_firewalluablock_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update a User Agent Blocking rule
      description: Updates an existing User Agent Blocking rule.
      operationId: user-agent-blocking-rules-update-a-user-agent-blocking-rule
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_ua-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
              - mode
              - configuration
      responses:
        '200':
          description: Update a User Agent Blocking rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_firewalluablock_response_single'
        4xx:
          description: Update a User Agent Blocking rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_firewalluablock_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/waf/overrides:
    get:
      tags:
      - Zones
      summary: Cloudflare List WAF overrides
      description: 'Fetches the URI-based WAF overrides in a zone.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-overrides-list-waf-overrides
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: page
        in: query
        schema:
          type: number
          description: The page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: The number of WAF overrides per page.
          default: 50
          minimum: 5
          maximum: 100
      responses:
        '200':
          description: List WAF overrides response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_override_response_collection'
        4xx:
          description: List WAF overrides response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_override_response_collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create a WAF override
      description: 'Creates a URI-based WAF override for a zone.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-overrides-create-a-waf-override
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - urls
      responses:
        '200':
          description: Create a WAF override response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_override_response_single'
        4xx:
          description: Create a WAF override response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_override_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/waf/overrides/{id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a WAF override
      description: 'Deletes an existing URI-based WAF override.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-overrides-delete-a-waf-override
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_overrides_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete a WAF override response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    properties:
                      id:
                        $ref: '#/components/schemas/legacy-jhs_overrides_components-schemas-id'
        4xx:
          description: Delete a WAF override response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/legacy-jhs_overrides_components-schemas-id'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get a WAF override
      description: 'Fetches the details of a URI-based WAF override.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-overrides-get-a-waf-override
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_overrides_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      responses:
        '200':
          description: Get a WAF override response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_override_response_single'
        4xx:
          description: Get a WAF override response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_override_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update WAF override
      description: 'Updates an existing URI-based WAF override.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-overrides-update-waf-override
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_overrides_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
              - urls
              - rules
              - rewrite_action
      responses:
        '200':
          description: Update WAF override response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_override_response_single'
        4xx:
          description: Update WAF override response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_override_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/waf/packages:
    get:
      tags:
      - Zones
      summary: Cloudflare List WAF packages
      description: 'Fetches WAF packages for a zone.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-packages-list-waf-packages
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: page
        in: query
        schema:
          type: number
          description: The page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: The number of packages per page.
          default: 50
          minimum: 5
          maximum: 100
      - name: order
        in: query
        schema:
          type: string
          description: The field used to sort returned packages.
          enum:
          - name
          example: status
      - name: direction
        in: query
        schema:
          type: string
          description: The direction used to sort returned packages.
          enum:
          - asc
          - desc
          example: desc
      - name: match
        in: query
        schema:
          type: string
          description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
          enum:
          - any
          - all
          default: all
      - name: name
        in: query
        schema:
          type: string
          description: The name of the WAF package.
          example: USER
          readOnly: true
      responses:
        '200':
          description: List WAF packages response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_package_response_collection'
        4xx:
          description: List WAF packages response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_package_response_collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/waf/packages/{identifier}:
    get:
      tags:
      - Zones
      summary: Cloudflare Get a WAF package
      description: 'Fetches the details of a WAF package.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-packages-get-a-waf-package
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_package_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      responses:
        '200':
          description: Get a WAF package response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_package_response_single'
        4xx:
          description: Get a WAF package response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_package_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Update a WAF package
      description: 'Updates a WAF package. You can update the sensitivity and the action of an anomaly detection WAF package.


        **Note:** Applies only to the [previous version of WAF managed rules](https://developers.cloudflare.com/support/firewall/managed-rules-web-application-firewall-waf/understanding-waf-managed-rules-web-application-firewall/).'
      operationId: waf-packages-update-a-waf-package
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_package_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action_mode:
                  $ref: '#/components/schemas/legacy-jhs_action_mode'
                sensitivity:
                  $ref: '#/components/schemas/legacy-jhs_sensitivity'
      responses:
        '200':
          description: Update a WAF package response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_package_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/legacy-jhs_anomaly_package'
        4xx:
          description: Update a WAF package response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/legacy-jhs_package_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/legacy-jhs_anomaly_package'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/healthchecks:
    get:
      tags:
      - Zones
      summary: Cloudflare List Health Checks
      description: List configured health checks.
      operationId: health-checks-list-health-checks
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      responses:
        '200':
          description: List Health Checks response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_response_collection'
        4XX:
          description: List Health Checks response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_response_collection'
                - $ref: '#/components/schemas/healthchecks_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Health Check
      description: Create a new health check.
      operationId: health-checks-create-health-check
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/healthchecks_query_healthcheck'
      responses:
        '200':
          description: Create Health Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_single_response'
        4XX:
          description: Create Health Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_single_response'
                - $ref: '#/components/schemas/healthchecks_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/healthchecks/{identifier}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Health Check
      description: Delete a health check.
      operationId: health-checks-delete-health-check
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Health Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_id_response'
        4XX:
          description: Delete Health Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_id_response'
                - $ref: '#/components/schemas/healthchecks_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Health Check Details
      description: Fetch a single configured health check.
      operationId: health-checks-health-check-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      responses:
        '200':
          description: Health Check Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_single_response'
        4XX:
          description: Health Check Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_single_response'
                - $ref: '#/components/schemas/healthchecks_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Patch Health Check
      description: Patch a configured health check.
      operationId: health-checks-patch-health-check
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/healthchecks_query_healthcheck'
      responses:
        '200':
          description: Patch Health Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_single_response'
        4XX:
          description: Patch Health Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_single_response'
                - $ref: '#/components/schemas/healthchecks_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Health Check
      description: Update a configured health check.
      operationId: health-checks-update-health-check
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/healthchecks_query_healthcheck'
      responses:
        '200':
          description: Update Health Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_single_response'
        4XX:
          description: Update Health Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_single_response'
                - $ref: '#/components/schemas/healthchecks_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/healthchecks/preview:
    post:
      tags:
      - Zones
      summary: Cloudflare Create Preview Health Check
      description: Create a new preview health check.
      operationId: health-checks-create-preview-health-check
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/healthchecks_query_healthcheck'
      responses:
        '200':
          description: Create Preview Health Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_single_response'
        4XX:
          description: Create Preview Health Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_single_response'
                - $ref: '#/components/schemas/healthchecks_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/healthchecks/preview/{identifier}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Preview Health Check
      description: Delete a health check.
      operationId: health-checks-delete-preview-health-check
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Preview Health Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_id_response'
        4XX:
          description: Delete Preview Health Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_id_response'
                - $ref: '#/components/schemas/healthchecks_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Health Check Preview Details
      description: Fetch a single configured health check preview.
      operationId: health-checks-health-check-preview-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/healthchecks_identifier'
      responses:
        '200':
          description: Health Check Preview Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_single_response'
        4XX:
          description: Health Check Preview Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_single_response'
                - $ref: '#/components/schemas/healthchecks_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/logs/control/retention/flag:
    get:
      tags:
      - Zones
      summary: Cloudflare Get log retention flag
      description: Gets log retention flag for Logpull API.
      operationId: logs-received-get-log-retention-flag
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_identifier'
      responses:
        '200':
          description: Get log retention flag response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data-zone-analytics-api_flag_response'
        4XX:
          description: Get log retention flag response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/data-zone-analytics-api_flag_response'
                - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Update log retention flag
      description: Updates log retention flag for Logpull API.
      operationId: logs-received-update-log-retention-flag
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - flag
              properties:
                flag:
                  $ref: '#/components/schemas/data-zone-analytics-api_flag'
      responses:
        '200':
          description: Update log retention flag response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data-zone-analytics-api_flag_response'
        4XX:
          description: Update log retention flag response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/data-zone-analytics-api_flag_response'
                - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_identifier}/logs/rayids/{ray_identifier}:
    get:
      tags:
      - Zones
      summary: Cloudflare Get logs RayIDs
      description: The `/rayids` api route allows lookups by specific rayid. The rayids route will return zero, one, or more records (ray ids are not unique).
      operationId: logs-received-get-logs-ray-i-ds
      parameters:
      - name: ray_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_ray_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_identifier'
      - name: timestamps
        in: query
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_timestamps'
      - name: fields
        in: query
        schema:
          type: string
          description: 'The `/received` route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. Most customers require only a small subset of fields, but that subset varies from customer to customer; 2. Flat schema is much easier to work with downstream (importing into BigTable etc); 3. Performance (time to process, file size). If `?fields=` is not specified, default field set is returned. This default field set may change at any time. When `?fields=` is provided, each record is returned with the specified fields. `fields` must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified does not matter, and the order of fields in the response is not specified.'
          example: ClientIP,RayID,EdgeStartTimestamp
      responses:
        '200':
          description: Get logs RayIDs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data-zone-analytics-api_logs'
        4XX:
          description: Get logs RayIDs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/data-zone-analytics-api_logs'
                - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_identifier}/logs/received:
    get:
      tags:
      - Zones
      summary: Cloudflare Get logs received
      description: 'The `/received` api route allows customers to retrieve their edge HTTP logs. The basic access pattern is "give me all the logs for zone Z for minute M", where the minute M refers to the time records were received at Cloudflare''s central data center. `start` is inclusive, and `end` is exclusive. Because of that, to get all data, at minutely cadence, starting at 10AM, the proper values are: `start=2018-05-20T10:00:00Z&end=2018-05-20T10:01:00Z`, then `start=2018-05-20T10:01:00Z&end=2018-05-20T10:02:00Z` and so on; the overlap will be handled properly.'
      operationId: logs-received-get-logs-received
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_identifier'
      - name: end
        in: query
        required: true
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_end'
      - name: sample
        in: query
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_sample'
      - name: timestamps
        in: query
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_timestamps'
      - name: count
        in: query
        schema:
          type: integer
          description: When `?count=` is provided, the response will contain up to `count` results. Since results are not sorted, you are likely to get different data for repeated requests. `count` must be an integer > 0.
          minimum: 1
      - name: fields
        in: query
        schema:
          type: string
          description: 'The `/received` route by default returns a limited set of fields, and allows customers to override the default field set by specifying individual fields. The reasons for this are: 1. Most customers require only a small subset of fields, but that subset varies from customer to customer; 2. Flat schema is much easier to work with downstream (importing into BigTable etc); 3. Performance (time to process, file size). If `?fields=` is not specified, default field set is returned. This default field set may change at any time. When `?fields=` is provided, each record is returned with the specified fields. `fields` must be specified as a comma separated list without any whitespaces, and all fields must exist. The order in which fields are specified does not matter, and the order of fields in the response is not specified.'
          example: ClientIP,RayID,EdgeStartTimestamp
      - name: start
        in: query
        schema:
          anyOf:
          - type: string
          - type: integer
          description: Sets the (inclusive) beginning of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than seven days.
          example: '2018-05-20T10:00:00Z'
      responses:
        '200':
          description: Get logs received response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data-zone-analytics-api_logs'
        4XX:
          description: Get logs received response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/data-zone-analytics-api_logs'
                - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_identifier}/logs/received/fields:
    get:
      tags:
      - Zones
      summary: Cloudflare List fields
      description: Lists all fields available. The response is json object with key-value pairs, where keys are field names, and values are descriptions.
      operationId: logs-received-list-fields
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/data-zone-analytics-api_identifier'
      responses:
        '200':
          description: List fields response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/data-zone-analytics-api_fields_response'
        4XX:
          description: List fields response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/data-zone-analytics-api_fields_response'
                - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
        api_token: []
  /zones/{zone_identifier}/rate_limits:
    get:
      tags:
      - Zones
      summary: Cloudflare List rate limits
      description: Fetches the rate limits for a zone.
      operationId: rate-limits-for-a-zone-list-rate-limits
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: page
        in: query
        schema:
          type: number
          description: The page number of paginated results.
          default: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.
          default: 20
          minimum: 1
          maximum: 1000
      responses:
        '200':
          description: List rate limits response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_ratelimit_response_collection'
        4xx:
          description: List rate limits response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_ratelimit_response_collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create a rate limit
      description: Creates a new rate limit for a zone. Refer to the object definition for a list of required attributes.
      operationId: rate-limits-for-a-zone-create-a-rate-limit
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - match
              - threshold
              - period
              - action
      responses:
        '200':
          description: Create a rate limit response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_ratelimit_response_single'
        4xx:
          description: Create a rate limit response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_ratelimit_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/rate_limits/{id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete a rate limit
      description: Deletes an existing rate limit.
      operationId: rate-limits-for-a-zone-delete-a-rate-limit
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_rate-limits_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete a rate limit response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_ratelimit_response_single'
                - type: object
                  properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/legacy-jhs_rate-limits_components-schemas-id'
        4xx:
          description: Delete a rate limit response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/legacy-jhs_ratelimit_response_single'
                  - type: object
                    properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/legacy-jhs_rate-limits_components-schemas-id'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get a rate limit
      description: Fetches the details of a rate limit.
      operationId: rate-limits-for-a-zone-get-a-rate-limit
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_rate-limits_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      responses:
        '200':
          description: Get a rate limit response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_ratelimit_response_single'
        4xx:
          description: Get a rate limit response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_ratelimit_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update a rate limit
      description: Updates an existing rate limit.
      operationId: rate-limits-for-a-zone-update-a-rate-limit
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_rate-limits_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
              - match
              - threshold
              - period
              - action
      responses:
        '200':
          description: Update a rate limit response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_ratelimit_response_single'
        4xx:
          description: Update a rate limit response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_ratelimit_response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/snippets:
    get:
      tags:
      - Zones
      summary: Cloudflare All Snippets
      operationId: zone-snippets
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/snippets-api_identifier'
      responses:
        '200':
          description: Snippets response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common'
                - type: object
                  properties:
                    result:
                      type: array
                      description: List of all zone snippets
                      items:
                        $ref: '#/components/schemas/snippets-api_snippet'
                type: object
        4XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
        5XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/snippets/{snippet_name}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Snippet
      operationId: zone-snippets-snippet-delete
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/snippets-api_identifier'
      - name: snippet_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/snippets-api_snippet_name'
      responses:
        '200':
          description: Snippet response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common'
                type: object
        4XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
        5XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Snippet
      operationId: zone-snippets-snippet
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/snippets-api_identifier'
      - name: snippet_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/snippets-api_snippet_name'
      responses:
        '200':
          description: Snippet response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/snippets-api_snippet'
                type: object
        4XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
        5XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Put Snippet
      operationId: zone-snippets-snippet-put
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/snippets-api_identifier'
      - name: snippet_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/snippets-api_snippet_name'
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: string
                  description: Content files of uploaded snippet
                  example: export { async function fetch(request, env) {return new Response('some_response') } }
                metadata:
                  type: object
                  properties:
                    main_module:
                      type: string
                      description: Main module name of uploaded snippet
                      example: main.js
      responses:
        '200':
          description: Snippet response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/snippets-api_snippet'
                type: object
        4XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
        5XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/snippets/{snippet_name}/content:
    get:
      tags:
      - Zones
      summary: Cloudflare Snippet Content
      operationId: zone-snippets-snippet-content
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/snippets-api_identifier'
      - name: snippet_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/snippets-api_snippet_name'
      responses:
        '200':
          description: Snippet response
          content:
            multipart/form-data:
              schema:
                properties:
                  files:
                    type: string
                    description: Content files of uploaded snippet
                    example: export { async function fetch(request, env) {return new Response('some_response') } }
        4XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
        5XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/snippets/snippet_rules:
    get:
      tags:
      - Zones
      summary: Cloudflare Rules
      operationId: zone-snippets-snippet-rules
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/snippets-api_identifier'
      responses:
        '200':
          description: Snippets rules response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/snippets-api_rules'
                type: object
        4XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
        5XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Put Rules
      operationId: zone-snippets-snippet-rules-put
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/snippets-api_identifier'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                rules:
                  $ref: '#/components/schemas/snippets-api_rules'
      responses:
        '200':
          description: Snippets rules response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/snippets-api_rules'
                type: object
        4XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
        5XX:
          description: Snippet response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/snippets-api_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/ssl/recommendation:
    get:
      tags:
      - Zones
      summary: Cloudflare SSL/TLS Recommendation
      description: Retrieve the SSL/TLS Recommender's recommendation for a zone.
      operationId: ssl/-tls-mode-recommendation-ssl/-tls-recommendation
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      responses:
        '200':
          description: SSL/TLS Recommendation response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_api-response-single'
                - properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/legacy-jhs_id'
                        modified_on:
                          $ref: '#/components/schemas/legacy-jhs_timestamp'
                        value:
                          $ref: '#/components/schemas/legacy-jhs_ssl-recommender_components-schemas-value'
        4xx:
          description: SSL/TLS Recommendation response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/legacy-jhs_api-response-single'
                  - properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/legacy-jhs_id'
                          modified_on:
                            $ref: '#/components/schemas/legacy-jhs_timestamp'
                          value:
                            $ref: '#/components/schemas/legacy-jhs_ssl-recommender_components-schemas-value'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/waiting_rooms:
    get:
      tags:
      - Zones
      summary: Cloudflare List waiting rooms
      description: Lists waiting rooms.
      operationId: waiting-room-list-waiting-rooms
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      responses:
        '200':
          description: List waiting rooms response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_response_collection'
        4XX:
          description: List waiting rooms response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_response_collection'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create waiting room
      description: Creates a new waiting room.
      operationId: waiting-room-create-waiting-room
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/waitingroom_query_waitingroom'
      responses:
        '200':
          description: Create waiting room response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_single_response'
        4XX:
          description: Create waiting room response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_single_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete waiting room
      description: Deletes a waiting room.
      operationId: waiting-room-delete-waiting-room
      parameters:
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete waiting room response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_waiting_room_id_response'
        4XX:
          description: Delete waiting room response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_waiting_room_id_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Waiting room details
      description: Fetches a single configured waiting room.
      operationId: waiting-room-waiting-room-details
      parameters:
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      responses:
        '200':
          description: Waiting room details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_single_response'
        4XX:
          description: Waiting room details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_single_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Patch waiting room
      description: Patches a configured waiting room.
      operationId: waiting-room-patch-waiting-room
      parameters:
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/waitingroom_query_waitingroom'
      responses:
        '200':
          description: Patch waiting room response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_single_response'
        4XX:
          description: Patch waiting room response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_single_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update waiting room
      description: Updates a configured waiting room.
      operationId: waiting-room-update-waiting-room
      parameters:
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/waitingroom_query_waitingroom'
      responses:
        '200':
          description: Update waiting room response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_single_response'
        4XX:
          description: Update waiting room response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_single_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events:
    get:
      tags:
      - Zones
      summary: Cloudflare List events
      description: Lists events for a waiting room.
      operationId: waiting-room-list-events
      parameters:
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      responses:
        '200':
          description: List events response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_event_response_collection'
        4XX:
          description: List events response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_event_response_collection'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create event
      description: Only available for the Waiting Room Advanced subscription. Creates an event for a waiting room. An event takes place during a specified period of time, temporarily changing the behavior of a waiting room. While the event is active, some of the properties in the event's configuration may either override or inherit from the waiting room's configuration. Note that events cannot overlap with each other, so only one event can be active at a time.
      operationId: waiting-room-create-event
      parameters:
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/waitingroom_query_event'
      responses:
        '200':
          description: Create event response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_event_response'
        4XX:
          description: Create event response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_event_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete event
      description: Deletes an event for a waiting room.
      operationId: waiting-room-delete-event
      parameters:
      - name: event_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_event_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete event response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_event_id_response'
        4XX:
          description: Delete event response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_event_id_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Event details
      description: Fetches a single configured event for a waiting room.
      operationId: waiting-room-event-details
      parameters:
      - name: event_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_event_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      responses:
        '200':
          description: Event details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_event_response'
        4XX:
          description: Event details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_event_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Patch event
      description: Patches a configured event for a waiting room.
      operationId: waiting-room-patch-event
      parameters:
      - name: event_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_event_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/waitingroom_query_event'
      responses:
        '200':
          description: Patch event response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_event_response'
        4XX:
          description: Patch event response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_event_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update event
      description: Updates a configured event for a waiting room.
      operationId: waiting-room-update-event
      parameters:
      - name: event_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_event_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/waitingroom_query_event'
      responses:
        '200':
          description: Update event response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_event_response'
        4XX:
          description: Update event response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_event_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}/details:
    get:
      tags:
      - Zones
      summary: Cloudflare Preview active event details
      description: Previews an event's configuration as if it was active. Inherited fields from the waiting room will be displayed with their current values.
      operationId: waiting-room-preview-active-event-details
      parameters:
      - name: event_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_event_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      responses:
        '200':
          description: Preview active event details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_event_details_response'
        4XX:
          description: Preview active event details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_event_details_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules:
    get:
      tags:
      - Zones
      summary: Cloudflare List Waiting Room Rules
      description: Lists rules for a waiting room.
      operationId: waiting-room-list-waiting-room-rules
      parameters:
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      responses:
        '200':
          description: List Waiting Room Rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_rules_response_collection'
        4XX:
          description: List Waiting Room Rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_rules_response_collection'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Waiting Room Rule
      description: Only available for the Waiting Room Advanced subscription. Creates a rule for a waiting room.
      operationId: waiting-room-create-waiting-room-rule
      parameters:
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/waitingroom_create_rule'
      responses:
        '200':
          description: Create Waiting Room Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_rules_response_collection'
        4XX:
          description: Create Waiting Room Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_rules_response_collection'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Replace Waiting Room Rules
      description: Only available for the Waiting Room Advanced subscription. Replaces all rules for a waiting room.
      operationId: waiting-room-replace-waiting-room-rules
      parameters:
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/waitingroom_update_rules'
      responses:
        '200':
          description: Replace Waiting Room Rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_rules_response_collection'
        4XX:
          description: Replace Waiting Room Rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_rules_response_collection'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules/{rule_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Waiting Room Rule
      description: Deletes a rule for a waiting room.
      operationId: waiting-room-delete-waiting-room-rule
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_rule_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Waiting Room Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_rules_response_collection'
        4XX:
          description: Delete Waiting Room Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_rules_response_collection'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Patch Waiting Room Rule
      description: Patches a rule for a waiting room.
      operationId: waiting-room-patch-waiting-room-rule
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_rule_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/waitingroom_patch_rule'
      responses:
        '200':
          description: Patch Waiting Room Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_rules_response_collection'
        4XX:
          description: Patch Waiting Room Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_rules_response_collection'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/status:
    get:
      tags:
      - Zones
      summary: Cloudflare Get waiting room status
      description: "Fetches the status of a configured waiting room. Response fields include:\n1. `status`: String indicating the status of the waiting room. The possible status are:\n\t- **not_queueing** indicates that the configured thresholds have not been met and all users are going through to the origin.\n\t- **queueing** indicates that the thresholds have been met and some users are held in the waiting room.\n\t- **event_prequeueing** indicates that an event is active and is currently prequeueing users before it starts.\n2. `event_id`: String of the current event's `id` if an event is active, otherwise an empty string.\n3. `estimated_queued_users`: Integer of the estimated number of users currently waiting in the queue.\n4. `estimated_total_active_users`: Integer of the estimated number of users currently active on the origin.\n5. `max_estimated_time_minutes`: Integer of the maximum estimated time currently presented to the users."
      operationId: waiting-room-get-waiting-room-status
      parameters:
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      responses:
        '200':
          description: Get waiting room status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_status_response'
        4XX:
          description: Get waiting room status response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_status_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/waiting_rooms/preview:
    post:
      tags:
      - Zones
      summary: Cloudflare Create a custom waiting room page preview
      description: "Creates a waiting room page preview. Upload a custom waiting room page for preview. You will receive a preview URL in the form `http://waitingrooms.dev/preview/<uuid>`. You can use the following query parameters to change the state of the preview:\n1. `force_queue`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website (also known as queueAll).\n2. `queue_is_full`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n3. `queueing_method`: The queueing method currently used by the waiting room.\n\t- **fifo** indicates a FIFO queue.\n\t- **random** indicates a Random queue.\n\t- **passthrough** indicates a Passthrough queue. Keep in mind that the waiting room page will only be displayed if `force_queue=true` or `event=prequeueing` — for other cases the request will pass through to the origin. For our preview, this will be a fake origin website returning \"Welcome\". \n\t- **reject** indicates a Reject queue.\n4. `event`: Used to preview a waiting room event.\n\t- **none** indicates no event is occurring.\n\t- **prequeueing** indicates that an event is prequeueing (between `prequeue_start_time` and `event_start_time`).\n\t- **started** indicates that an event has started (between `event_start_time` and `event_end_time`).\n5. `shuffle_at_event_start`: Boolean indicating if the event will shuffle users in the prequeue when it starts. This can only be set to **true** if an event is active (`event` is not **none**).\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/<uuid>?force_queue=false&queue_is_full=false&queueing_method=random&event=started&shuffle_at_event_start=true`\n6. `waitTime`: Non-zero, positive integer indicating the estimated wait time in minutes. The default value is 10 minutes.\n\nFor example, you can make a request to `http://waitingrooms.dev/preview/<uuid>?waitTime=50` to configure the estimated wait time as 50 minutes."
      operationId: waiting-room-create-a-custom-waiting-room-page-preview
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/waitingroom_query_preview'
      responses:
        '200':
          description: Create a custom waiting room page preview response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_preview_response'
        4XX:
          description: Create a custom waiting room page preview response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_preview_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/waiting_rooms/settings:
    get:
      tags:
      - Zones
      summary: Cloudflare Get zone-level Waiting Room settings
      operationId: waiting-room-get-zone-settings
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      responses:
        '200':
          description: The current zone-level Waiting Room settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_zone_settings_response'
        4XX:
          description: The current zone-level Waiting Room settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_zone_settings_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Patch zone-level Waiting Room settings
      operationId: waiting-room-patch-zone-settings
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/waitingroom_zone_settings'
      responses:
        '200':
          description: The updated zone-level Waiting Room settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_zone_settings_response'
        4XX:
          description: The zone-level Waiting Room settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_zone_settings_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update zone-level Waiting Room settings
      operationId: waiting-room-update-zone-settings
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waitingroom_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/waitingroom_zone_settings'
      responses:
        '200':
          description: The updated zone-level Waiting Room settings
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_zone_settings_response'
        4XX:
          description: The zone-level Waiting Room settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_zone_settings_response'
                - $ref: '#/components/schemas/waitingroom_api-response-common-failure'
      security:
      - api_token: []
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/web3/hostnames:
    get:
      tags:
      - Zones
      summary: Cloudflare List Web3 Hostnames
      operationId: web3-hostname-list-web3-hostnames
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      responses:
        '200':
          description: List Web3 Hostnames response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dweb-config_collection_response'
        5XX:
          description: List Web3 Hostnames response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dweb-config_collection_response'
                - $ref: '#/components/schemas/dweb-config_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Web3 Hostname
      operationId: web3-hostname-create-web3-hostname
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dweb-config_create_request'
      responses:
        '200':
          description: Create Web3 Hostname response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dweb-config_single_response'
        5XX:
          description: Create Web3 Hostname response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dweb-config_single_response'
                - $ref: '#/components/schemas/dweb-config_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/web3/hostnames/{identifier}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Web3 Hostname
      operationId: web3-hostname-delete-web3-hostname
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Web3 Hostname response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dweb-config_api-response-single-id'
        5XX:
          description: Delete Web3 Hostname response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dweb-config_api-response-single-id'
                - $ref: '#/components/schemas/dweb-config_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare Web3 Hostname Details
      operationId: web3-hostname-web3-hostname-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      responses:
        '200':
          description: Web3 Hostname Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dweb-config_single_response'
        5XX:
          description: Web3 Hostname Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dweb-config_single_response'
                - $ref: '#/components/schemas/dweb-config_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    patch:
      tags:
      - Zones
      summary: Cloudflare Edit Web3 Hostname
      operationId: web3-hostname-edit-web3-hostname
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dweb-config_modify_request'
      responses:
        '200':
          description: Edit Web3 Hostname response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dweb-config_single_response'
        5XX:
          description: Edit Web3 Hostname response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dweb-config_single_response'
                - $ref: '#/components/schemas/dweb-config_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list:
    get:
      tags:
      - Zones
      summary: Cloudflare IPFS Universal Path Gateway Content List Details
      operationId: web3-hostname-ipfs-universal-path-gateway-content-list-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      responses:
        '200':
          description: IPFS Universal Path Gateway Content List Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dweb-config_content_list_details_response'
        5XX:
          description: IPFS Universal Path Gateway Content List Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dweb-config_content_list_details_response'
                - $ref: '#/components/schemas/dweb-config_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update IPFS Universal Path Gateway Content List
      operationId: web3-hostname-update-ipfs-universal-path-gateway-content-list
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dweb-config_content_list_update_request'
      responses:
        '200':
          description: Update IPFS Universal Path Gateway Content List response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dweb-config_content_list_details_response'
        5XX:
          description: Update IPFS Universal Path Gateway Content List response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dweb-config_content_list_details_response'
                - $ref: '#/components/schemas/dweb-config_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries:
    get:
      tags:
      - Zones
      summary: Cloudflare List IPFS Universal Path Gateway Content List Entries
      operationId: web3-hostname-list-ipfs-universal-path-gateway-content-list-entries
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      responses:
        '200':
          description: List IPFS Universal Path Gateway Content List Entries response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dweb-config_content_list_entry_collection_response'
        5XX:
          description: List IPFS Universal Path Gateway Content List Entries response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dweb-config_content_list_entry_collection_response'
                - $ref: '#/components/schemas/dweb-config_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create IPFS Universal Path Gateway Content List Entry
      operationId: web3-hostname-create-ipfs-universal-path-gateway-content-list-entry
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dweb-config_content_list_entry_create_request'
      responses:
        '200':
          description: Create IPFS Universal Path Gateway Content List Entry response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dweb-config_content_list_entry_single_response'
        5XX:
          description: Create IPFS Universal Path Gateway Content List Entry response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dweb-config_content_list_entry_single_response'
                - $ref: '#/components/schemas/dweb-config_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  ? /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}
  : delete:
      tags:
      - Zones
      summary: Cloudflare Delete IPFS Universal Path Gateway Content List Entry
      operationId: web3-hostname-delete-ipfs-universal-path-gateway-content-list-entry
      parameters:
      - name: content_list_entry_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete IPFS Universal Path Gateway Content List Entry response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dweb-config_api-response-single-id'
        5XX:
          description: Delete IPFS Universal Path Gateway Content List Entry response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dweb-config_api-response-single-id'
                - $ref: '#/components/schemas/dweb-config_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    get:
      tags:
      - Zones
      summary: Cloudflare IPFS Universal Path Gateway Content List Entry Details
      operationId: web3-hostname-ipfs-universal-path-gateway-content-list-entry-details
      parameters:
      - name: content_list_entry_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      responses:
        '200':
          description: IPFS Universal Path Gateway Content List Entry Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dweb-config_content_list_entry_single_response'
        5XX:
          description: IPFS Universal Path Gateway Content List Entry Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dweb-config_content_list_entry_single_response'
                - $ref: '#/components/schemas/dweb-config_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
    put:
      tags:
      - Zones
      summary: Cloudflare Edit IPFS Universal Path Gateway Content List Entry
      operationId: web3-hostname-edit-ipfs-universal-path-gateway-content-list-entry
      parameters:
      - name: content_list_entry_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dweb-config_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dweb-config_content_list_entry_create_request'
      responses:
        '200':
          description: Edit IPFS Universal Path Gateway Content List Entry response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dweb-config_content_list_entry_single_response'
        5XX:
          description: Edit IPFS Universal Path Gateway Content List Entry response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dweb-config_content_list_entry_single_response'
                - $ref: '#/components/schemas/dweb-config_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
  /zones/{zone}/spectrum/analytics/aggregate/current:
    get:
      tags:
      - Zones
      summary: Cloudflare Get current aggregated analytics
      description: Retrieves analytics aggregated from the last minute of usage on Spectrum applications underneath a given zone.
      operationId: spectrum-aggregate-analytics-get-current-aggregated-analytics
      parameters:
      - name: zone
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: appID
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_app_id_param'
      - name: app_id_param
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_app_id_param'
      - name: colo_name
        in: query
        schema:
          type: string
          description: Co-location identifier.
          example: PDX
          maxLength: 3
      responses:
        '200':
          description: Get current aggregated analytics response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_analytics-aggregate_components-schemas-response_collection'
        4xx:
          description: Get current aggregated analytics response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_analytics-aggregate_components-schemas-response_collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone}/spectrum/analytics/events/bytime:
    get:
      tags:
      - Zones
      summary: Cloudflare Get analytics by time
      description: Retrieves a list of aggregate metrics grouped by time interval.
      operationId: spectrum-analytics-(-by-time)-get-analytics-by-time
      parameters:
      - name: zone
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: dimensions
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_dimensions'
      - name: sort
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_sort'
      - name: until
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_schemas-until'
      - name: metrics
        in: query
        schema:
          type: array
          description: "One or more metrics to compute. Options are: \n\nMetric                    | Name                                | Example                  | Unit\n--|-|--|--\ncount                     | Count of total events               | 1000                     | Count\nbytesIngress              | Sum of ingress bytes                | 1000                     | Sum\nbytesEgress               | Sum of egress bytes                 | 1000                     | Sum\ndurationAvg               | Average connection duration         | 1.0                      | Time in milliseconds\ndurationMedian            | Median connection duration          | 1.0                      | Time in milliseconds\nduration90th              | 90th percentile connection duration | 1.0                      | Time in milliseconds\nduration99th              | 99th percentile connection duration | 1.0                      | Time in milliseconds."
          example:
          - count
          - bytesIngress
          items:
            type: string
            enum:
            - count
            - bytesIngress
            - bytesEgress
            - durationAvg
            - durationMedian
            - duration90th
            - duration99th
      - name: filters
        in: query
        schema:
          type: string
          description: "Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: \n\nOperator                  | Name                            | URL Encoded\n--||--\n==                        | Equals                          | %3D%3D\n!=                        | Does not equals                 | !%3D\n>                        | Greater Than                    | %3E\n<                         | Less Than                       | %3C\n>=                       | Greater than or equal to        | %3E%3D\n<=                        | Less than or equal to           | %3C%3D     ."
          example: event==disconnect%20AND%20coloName!=SFO
      - name: since
        in: query
        schema:
          type: string
          format: date-time
          description: Start of time interval to query, defaults to `until` - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
          example: '2014-01-02T02:20:00Z'
      - name: time_delta
        in: query
        schema:
          type: string
          description: Used to select time series resolution.
          enum:
          - year
          - quarter
          - month
          - week
          - day
          - hour
          - dekaminute
          - minute
          example: minute
      responses:
        '200':
          description: Get analytics by time response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_api-response-single'
        4xx:
          description: Get analytics by time response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_api-response-single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone}/spectrum/analytics/events/summary:
    get:
      tags:
      - Zones
      summary: Cloudflare Get analytics summary
      description: Retrieves a list of summarised aggregate metrics over a given time period.
      operationId: spectrum-analytics-(-summary)-get-analytics-summary
      parameters:
      - name: zone
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: dimensions
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_dimensions'
      - name: sort
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_sort'
      - name: until
        in: query
        schema:
          $ref: '#/components/schemas/legacy-jhs_schemas-until'
      - name: metrics
        in: query
        schema:
          type: array
          description: "One or more metrics to compute. Options are: \n\nMetric                    | Name                                | Example                  | Unit\n--|-|--|--\ncount                     | Count of total events               | 1000                     | Count\nbytesIngress              | Sum of ingress bytes                | 1000                     | Sum\nbytesEgress               | Sum of egress bytes                 | 1000                     | Sum\ndurationAvg               | Average connection duration         | 1.0                      | Time in milliseconds\ndurationMedian            | Median connection duration          | 1.0                      | Time in milliseconds\nduration90th              | 90th percentile connection duration | 1.0                      | Time in milliseconds\nduration99th              | 99th percentile connection duration | 1.0                      | Time in milliseconds."
          example:
          - count
          - bytesIngress
          items:
            type: string
            enum:
            - count
            - bytesIngress
            - bytesEgress
            - durationAvg
            - durationMedian
            - duration90th
            - duration99th
      - name: filters
        in: query
        schema:
          type: string
          description: "Used to filter rows by one or more dimensions. Filters can be combined using OR and AND boolean logic. AND takes precedence over OR in all the expressions. The OR operator is defined using a comma (,) or OR keyword surrounded by whitespace. The AND operator is defined using a semicolon (;) or AND keyword surrounded by whitespace. Note that the semicolon is a reserved character in URLs (rfc1738) and needs to be percent-encoded as %3B. Comparison options are: \n\nOperator                  | Name                            | URL Encoded\n--||--\n==                        | Equals                          | %3D%3D\n!=                        | Does not equals                 | !%3D\n>                        | Greater Than                    | %3E\n<                         | Less Than                       | %3C\n>=                       | Greater than or equal to        | %3E%3D\n<=                        | Less than or equal to           | %3C%3D     ."
          example: event==disconnect%20AND%20coloName!=SFO
      - name: since
        in: query
        schema:
          type: string
          format: date-time
          description: Start of time interval to query, defaults to `until` - 6 hours. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
          example: '2014-01-02T02:20:00Z'
      responses:
        '200':
          description: Get analytics summary response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_api-response-single'
        4xx:
          description: Get analytics summary response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_api-response-single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone}/spectrum/apps:
    get:
      tags:
      - Zones
      summary: Cloudflare List Spectrum applications
      description: Retrieves a list of currently existing Spectrum applications inside a zone.
      operationId: spectrum-applications-list-spectrum-applications
      parameters:
      - name: zone
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      - name: page
        in: query
        schema:
          type: number
          description: Page number of paginated results. This parameter is required in order to use other pagination parameters. If included in the query, `result_info` will be present in the response.
          example: 1
          minimum: 1
      - name: per_page
        in: query
        schema:
          type: number
          description: Sets the maximum number of results per page.
          default: 20
          minimum: 1
          maximum: 100
      - name: direction
        in: query
        schema:
          type: string
          description: Sets the direction by which results are ordered.
          enum:
          - asc
          - desc
          default: asc
          example: desc
      - name: order
        in: query
        schema:
          type: string
          description: Application field by which results are ordered.
          enum:
          - protocol
          - app_id
          - created_on
          - modified_on
          - dns
          default: dns
          example: protocol
      responses:
        '200':
          description: List Spectrum applications response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_components-schemas-response_collection'
        4xx:
          description: List Spectrum applications response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_components-schemas-response_collection'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zones
      summary: Cloudflare Create Spectrum application using a name for the origin
      description: Creates a new Spectrum application from a configuration using a name for the origin.
      operationId: spectrum-applications-create-spectrum-application-using-a-name-for-the-origin
      parameters:
      - name: zone
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - protocol
              - dns
              - origin_dns
              - origin_port
              properties:
                argo_smart_routing:
                  $ref: '#/components/schemas/legacy-jhs_argo_smart_routing'
                dns:
                  $ref: '#/components/schemas/legacy-jhs_dns'
                edge_ips:
                  $ref: '#/components/schemas/legacy-jhs_edge_ips'
                ip_firewall:
                  $ref: '#/components/schemas/legacy-jhs_ip_firewall'
                origin_dns:
                  $ref: '#/components/schemas/legacy-jhs_origin_dns'
                origin_port:
                  $ref: '#/components/schemas/legacy-jhs_origin_port'
                protocol:
                  $ref: '#/components/schemas/legacy-jhs_protocol'
                proxy_protocol:
                  $ref: '#/components/schemas/legacy-jhs_proxy_protocol'
                tls:
                  $ref: '#/components/schemas/legacy-jhs_tls'
                traffic_type:
                  $ref: '#/components/schemas/legacy-jhs_traffic_type'
      responses:
        '200':
          description: Create Spectrum application using a name for the origin response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_response_single_origin_dns'
        4xx:
          description: Create Spectrum application using a name for the origin response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_response_single_origin_dns'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone}/spectrum/apps/{app_id}:
    delete:
      tags:
      - Zones
      summary: Cloudflare Delete Spectrum application
      description: Deletes a previously existing application.
      operationId: spectrum-applications-delete-spectrum-application
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_app_id'
      - name: zone
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        '200':
          description: Delete Spectrum application response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_api-response-single'
                - type: object
                  properties:
                    result:
                      type: object
                      properties:
                        id:
                          $ref: '#/components/schemas/legacy-jhs_app_id'
        4xx:
          description: Delete Spectrum application response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/legacy-jhs_api-response-single'
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            $ref: '#/components/schemas/legacy-jhs_app_id'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zones
      summary: Cloudflare Get Spectrum application configuration
      description: Gets the application configuration of a specific application inside a zone.
      operationId: spectrum-applications-get-spectrum-application-configuration
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_app_id'
      - name: zone
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      responses:
        '200':
          description: Get Spectrum application configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_schemas-response_single'
        4xx:
          description: Get Spectrum application configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_schemas-response_single'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zones
      summary: Cloudflare Update Spectrum application configuration using a name for the origin
      description: Updates a previously existing application's configuration that uses a name for the origin.
      operationId: spectrum-applications-update-spectrum-application-configuration-using-a-name-for-the-origin
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_app_id'
      - name: zone
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - protocol
              - dns
              - origin_dns
              - origin_port
              properties:
                argo_smart_routing:
                  $ref: '#/components/schemas/legacy-jhs_argo_smart_routing'
                dns:
                  $ref: '#/components/schemas/legacy-jhs_dns'
                edge_ips:
                  $ref: '#/components/schemas/legacy-jhs_edge_ips'
                ip_firewall:
                  $ref: '#/components/schemas/legacy-jhs_ip_firewall'
                origin_dns:
                  $ref: '#/components/schemas/legacy-jhs_origin_dns'
                origin_port:
                  $ref: '#/components/schemas/legacy-jhs_origin_port'
                protocol:
                  $ref: '#/components/schemas/legacy-jhs_protocol'
                proxy_protocol:
                  $ref: '#/components/schemas/legacy-jhs_proxy_protocol'
                tls:
                  $ref: '#/components/schemas/legacy-jhs_tls'
                traffic_type:
                  $ref: '#/components/schemas/legacy-jhs_traffic_type'
      responses:
        '200':
          description: Update Spectrum application configuration using a name for the origin response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/legacy-jhs_response_single_origin_dns'
        4xx:
          description: Update Spectrum application configuration using a name for the origin response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/legacy-jhs_response_single_origin_dns'
                - $ref: '#/components/schemas/legacy-jhs_api-response-common-failure'
      security:
      - api_email: []
        api_key: []
      - api_token: []
components:
  schemas:
    legacy-jhs_urls:
      type: array
      description: The URLs to include in the current WAF override. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.
      items:
        type: string
        example: shop.example.com/*
    page-shield_connection:
      properties:
        added_at:
          example: '2021-08-18T10:51:10.09615Z'
        domain_reported_malicious:
          example: false
        first_page_url:
          example: blog.cloudflare.com/page
        first_seen_at:
          example: '2021-08-18T10:51:08Z'
        host:
          example: blog.cloudflare.com
        id:
          example: c9ef84a6bf5e47138c75d95e2f933e8f
        last_seen_at:
          example: '2021-09-02T09:57:54Z'
        page_urls:
          example:
          - blog.cloudflare.com/page1
          - blog.cloudflare.com/page2
        url:
          example: https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js
        url_contains_cdn_cgi_path:
          example: false
    bill-subs-api_component_value:
      type: object
      description: A component value for a subscription.
      properties:
        default:
          type: number
          description: The default amount assigned.
          example: 5
        name:
          type: string
          description: The name of the component value.
          example: page_rules
        price:
          type: number
          description: The unit price for the component value.
          example: 5
        value:
          type: number
          description: The amount of the component value assigned.
          example: 20
    access_ui_read_only_toggle_reason:
      type: string
      description: A description of the reason why the UI read only field is being toggled.
      example: Temporarily turn off the UI read only lock to make a change via the UI
    access_schemas-warp_props:
      allOf:
      - $ref: '#/components/schemas/access_schemas-feature_app_props'
      - properties:
          domain:
            example: authdomain.cloudflareaccess.com/warp
            readOnly: true
          name:
            default: Warp Login App
            example: Warp Login App
            readOnly: true
          type:
            type: string
            description: The application type.
            example: warp
    legacy-jhs_zonelockdown_response_collection:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-collection'
      - type: object
        required:
        - result
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/legacy-jhs_zonelockdown'
    logpush_destination_conf:
      type: string
      format: uri
      description: Uniquely identifies a resource (such as an s3 bucket) where data will be pushed. Additional configuration parameters supported by the destination may be included.
      example: s3://mybucket/logs?region=us-west-2
      maxLength: 4096
    legacy-jhs_timestamp:
      type: string
      format: date-time
      example: '2014-01-01T05:20:00.12345Z'
      readOnly: true
    waitingroom_event_details_disable_session_renewal:
      type: boolean
      example: false
    access_domain_rule:
      type: object
      title: Email domain
      description: Match an entire email domain.
      required:
      - email_domain
      properties:
        email_domain:
          type: object
          required:
          - domain
          properties:
            domain:
              type: string
              description: The email domain to match.
              example: example.com
    bill-subs-api_components-schemas-name:
      description: The unique component.
      enum:
      - zones
      - page_rules
      - dedicated_certificates
      - dedicated_certificates_custom
      example: page_rules
    legacy-jhs_schemas-ip_configuration:
      title: An IP address configuration.
      properties:
        target:
          description: The configuration target. You must set the target to `ip` when specifying an IP address in the Zone Lockdown rule.
          enum:
          - ip
          example: ip
        value:
          type: string
          description: The IP address to match. This address will be compared to the IP address of incoming requests.
          example: 198.51.100.4
    tls-certificates-and-hostnames_base:
      type: object
      required:
      - id
      - name
      - host
      - port
      - status
      - enabled
      - permissions
      - created_on
      - modified_on
      properties:
        created_on:
          type: string
          format: date-time
          description: When the Keyless SSL was created.
          example: '2014-01-01T05:20:00Z'
          readOnly: true
        enabled:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_enabled'
        host:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_host'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-identifier'
        modified_on:
          type: string
          format: date-time
          description: When the Keyless SSL was last modified.
          example: '2014-01-01T05:20:00Z'
          readOnly: true
        name:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_name'
        permissions:
          type: array
          description: Available permissions for the Keyless SSL for the current user requesting the item.
          example:
          - '#ssl:read'
          - '#ssl:edit'
          readOnly: true
          items: {}
        port:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_port'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-status'
        tunnel:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_tunnel'
    zones_edge_cache_ttl_value:
      type: number
      description: 'Value of the zone setting.

        Notes: The minimum TTL available depends on the plan level of the zone. (Enterprise = 30, Business = 1800, Pro = 3600, Free = 7200)'
      enum:
      - 30
      - 60
      - 300
      - 1200
      - 1800
      - 3600
      - 7200
      - 10800
      - 14400
      - 18000
      - 28800
      - 43200
      - 57600
      - 72000
      - 86400
      - 172800
      - 259200
      - 345600
      - 432000
      - 518400
      - 604800
      default: 7200
    access_client_secret:
      type: string
      description: The Client Secret for the service token. Access will check for this value in the `CF-Access-Client-Secret` request header.
      example: bdd31cbc4dec990953e39163fbbb194c93313ca9f0a6e420346af9d326b1d2a5
    dns-records_match:
      type: string
      description: 'Whether to match all search requirements or at least one (any). If set to `all`, acts like a logical AND between filters. If set to `any`, acts like a logical OR instead. Note that the interaction between tag filters is controlled by the `tag-match` parameter instead.

        '
      enum:
      - any
      - all
      default: all
      example: any
    rulesets_Ruleset:
      type: object
      title: Ruleset
      description: A ruleset object.
      required:
      - id
      - version
      - last_updated
      properties:
        description:
          type: string
          title: Description
          description: An informative description of the ruleset.
          default: ''
          example: My ruleset to execute managed rulesets
        id:
          allOf:
          - $ref: '#/components/schemas/rulesets_RulesetId'
          - readOnly: true
        kind:
          $ref: '#/components/schemas/rulesets_RulesetKind'
        last_updated:
          type: string
          title: Last updated
          format: date-time
          description: The timestamp of when the ruleset was last modified.
          example: '2000-01-01T00:00:00.000000Z'
          readOnly: true
        name:
          type: string
          title: Name
          description: The human-readable name of the ruleset.
          example: My ruleset
          minLength: 1
        phase:
          $ref: '#/components/schemas/rulesets_RulesetPhase'
        version:
          $ref: '#/components/schemas/rulesets_RulesetVersion'
    cache_cache_reserve_clear:
      allOf:
      - $ref: '#/components/schemas/cache_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - cache_reserve_clear
            example: cache_reserve_clear
      title: Cache Reserve Clear
      description: You can use Cache Reserve Clear to clear your Cache Reserve, but you must first disable Cache Reserve. In most cases, this will be accomplished within 24 hours. You cannot re-enable Cache Reserve while this process is ongoing. Keep in mind that you cannot undo or cancel this operation.
    waitingroom_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/waitingroom_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/waitingroom_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    api-shield_traffic_stats:
      type: object
      readOnly: true
      properties:
        traffic_stats:
          type: object
          required:
          - period_seconds
          - requests
          - last_updated
          properties:
            last_updated:
              $ref: '#/components/schemas/api-shield_timestamp'
            period_seconds:
              type: integer
              description: The period in seconds these statistics were computed over
              example: 3600
              readOnly: true
            requests:
              type: number
              format: float
              description: The average number of requests seen during this period
              example: 1987.06
              readOnly: true
    workers_filter-response-collection:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/workers_filters'
    api-shield_validation_default_mitigation_action_patch:
      type: string
      description: "The default mitigation action used when there is no mitigation action defined on the operation\nMitigation actions are as follows:\n\n  * `log` - log request when request does not conform to schema\n  * `block` - deny access to the site when request does not conform to schema\n\nA special value of of `none` will skip running schema validation entirely for the request when there is no mitigation action defined on the operation\n\n`null` will have no effect.\n"
      enum:
      - none
      - log
      - block
      - null
      example: block
      nullable: true
    api-shield_parameter_schemas_definition:
      type: object
      description: An operation schema object containing a response.
      example:
        parameters:
        - description: Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema.
          in: path
          name: var1
          required: true
          schema:
            maximum: 10
            minimum: 1
            type: integer
        responses: null
      readOnly: true
      properties:
        parameters:
          type: array
          description: An array containing the learned parameter schemas.
          example:
          - description: Sufficient requests have been observed for this parameter to provide high confidence in this parameter schema.
            in: path
            name: var1
            required: true
            schema:
              maximum: 10
              minimum: 1
              type: integer
          readOnly: true
          items: {}
        responses:
          type: object
          description: An empty response object. This field is required to yield a valid operation schema.
          nullable: true
          readOnly: true
    dweb-config_timestamp:
      type: string
      format: date-time
      example: '2014-01-01T05:20:00.12345Z'
      readOnly: true
    waitingroom_status_event_id:
      type: string
      example: 25756b2dfe6e378a06b033b670413757
    legacy-jhs_dns_type:
      type: string
      description: The type of DNS record associated with the application.
      enum:
      - CNAME
      - ADDRESS
      example: CNAME
    legacy-jhs_filter-rules-response-collection:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-collection'
      - type: object
        required:
        - result
        properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/legacy-jhs_filter-rule-response'
              - type: object
                required:
                - id
                - filter
                - action
                - paused
    workers_routes:
      type: object
      required:
      - id
      - pattern
      - script
      properties:
        id:
          $ref: '#/components/schemas/workers_identifier'
        pattern:
          $ref: '#/components/schemas/workers_pattern'
        script:
          $ref: '#/components/schemas/workers_script_name'
    waitingroom_event_disable_session_renewal:
      type: boolean
      description: If set, the event will override the waiting room's `disable_session_renewal` property while it is active. If null, the event will inherit it.
      nullable: true
    tls-certificates-and-hostnames_schemas-hostname:
      type: string
      description: The hostname on the origin for which the client certificate uploaded will be used.
      example: app.example.com
      maxLength: 255
    cache-purge_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/cache-purge_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/cache-purge_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    access_any_valid_service_token_rule:
      type: object
      title: Any Valid Service Token
      description: Matches any valid Access Service Token
      required:
      - any_valid_service_token
      properties:
        any_valid_service_token:
          type: object
          description: An empty object which matches on all service tokens.
          example: {}
    zones_early_hints_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    zones_tls_1_3_value:
      type: string
      description: 'Value of the zone setting.

        Notes: Default value depends on the zone''s plan level.'
      enum:
      - 'on'
      - 'off'
      - zrt
      default: 'off'
    legacy-jhs_groups:
      type: object
      description: An object that allows you to enable or disable WAF rule groups for the current WAF override. Each key of this object must be the ID of a WAF rule group, and each value must be a valid WAF action (usually `default` or `disable`). When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.
      example:
        ea8687e59929c1fd05ba97574ad43f77: default
    access_schemas-exclude:
      type: array
      description: Rules evaluated with a NOT logical operator. To match the policy, a user cannot meet any of the Exclude rules.
      items:
        $ref: '#/components/schemas/access_rule'
    data-zone-analytics-api_timeseries:
      type: array
      description: Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters.
      items:
        type: object
        properties:
          bandwidth:
            $ref: '#/components/schemas/data-zone-analytics-api_bandwidth'
          pageviews:
            $ref: '#/components/schemas/data-zone-analytics-api_pageviews'
          requests:
            $ref: '#/components/schemas/data-zone-analytics-api_requests'
          since:
            $ref: '#/components/schemas/data-zone-analytics-api_since'
          threats:
            $ref: '#/components/schemas/data-zone-analytics-api_threats'
          uniques:
            $ref: '#/components/schemas/data-zone-analytics-api_uniques'
          until:
            $ref: '#/components/schemas/data-zone-analytics-api_until'
    workers_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    tls-certificates-and-hostnames_quota:
      type: object
      properties:
        allocated:
          type: integer
          description: Quantity Allocated.
        used:
          type: integer
          description: Quantity Used.
    argo-config_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    legacy-jhs_filter:
      type: object
      properties:
        description:
          $ref: '#/components/schemas/legacy-jhs_filters_components-schemas-description'
        expression:
          $ref: '#/components/schemas/legacy-jhs_expression'
        id:
          $ref: '#/components/schemas/legacy-jhs_filters_components-schemas-id'
        paused:
          $ref: '#/components/schemas/legacy-jhs_filters_components-schemas-paused'
        ref:
          $ref: '#/components/schemas/legacy-jhs_schemas-ref'
    observatory_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      properties:
        errors:
          $ref: '#/components/schemas/observatory_messages'
        messages:
          $ref: '#/components/schemas/observatory_messages'
        success:
          type: boolean
          description: Whether the API call was successful.
          example: true
    rulesets_Messages:
      type: array
      title: Messages
      description: A list of warning messages.
      items:
        $ref: '#/components/schemas/rulesets_Message'
    waf-managed-rules_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/waf-managed-rules_messages'
        messages:
          $ref: '#/components/schemas/waf-managed-rules_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    zones_settings:
      type: array
      description: Settings available for the zone.
      example:
      - id: browser_check
        properties:
        - name: value
          type: toggle
      - id: browser_cache_ttl
        properties:
        - max: 31536000
          min: 1800
          name: value
          suggested_values:
          - 1800
          - 3600
          - 7200
          - 10800
          - 14400
          - 18000
          - 28800
          - 43200
          - 57600
          - 72000
          - 86400
          - 172800
          - 259200
          - 345600
          - 432000
          - 691200
          - 1382400
          - 2073600
          - 2678400
          - 5356800
          - 16070400
          - 31536000
          type: range
      - id: browser_check
        properties:
        - name: value
          type: toggle
      - id: cache_key_fields
        properties:
        - name: value
          properties:
          - allowEmpty: true
            choices:
            - include
            - exclude
            multiple: false
            name: query_string
            type: select
          - allowEmpty: true
            choices:
            - include
            - exclude
            - check_presence
            multiple: true
            name: header
            type: select
          - allowEmpty: false
            choices:
            - resolved
            multiple: true
            name: host
            type: select
          - allowEmpty: true
            choices:
            - include
            - check_presence
            multiple: true
            name: cookie
            type: select
          - allowEmpty: false
            choices:
            - device_type
            - geo
            - lang
            multiple: true
            name: user
            type: select
          type: object
      - id: cache_deception_armor
        properties:
        - name: value
          type: toggle
      - id: cache_level
        properties:
        - choices:
          - bypass
          - basic
          - simplified
          - aggressive
          - cache_everything
          multiple: false
          name: value
          type: select
      - id: cache_ttl_by_status
        properties:
        - allowEmpty: false
          name: value
          type: object
      - id: disable_apps
        properties: []
      - id: disable_performance
        properties: []
      - id: disable_security
        properties: []
      - id: edge_cache_ttl
        properties:
        - max: 2419200
          min: 7200
          name: value
          suggested_values:
          - 7200
          - 10800
          - 14400
          - 18000
          - 28800
          - 43200
          - 57600
          - 72000
          - 86400
          - 172800
          - 259200
          - 345600
          - 432000
          - 518400
          - 604800
          - 1209600
          - 2419200
          type: range
      - id: email_obfuscation
        properties:
        - name: value
          type: toggle
      - id: forwarding_url
        properties:
        - choices:
          - 301
          - 302
          multiple: false
          name: status_code
          type: choice
        - name: url
          type: forwardingUrl
      - id: ip_geolocation
        properties:
        - name: value
          type: toggle
      - id: minify
        properties:
        - allowEmpty: true
          choices:
          - html
          - css
          - js
          multiple: true
          name: value
          type: select
      - id: explicit_cache_control
        properties:
        - name: value
          type: toggle
      - id: rocket_loader
        properties:
        - name: value
          type: toggle
      - id: security_level
        properties:
        - choices:
          - essentially_off
          - low
          - medium
          - high
          - under_attack
          multiple: false
          name: value
          type: select
      - id: server_side_exclude
        properties:
        - name: value
          type: toggle
      - id: ssl
        properties:
        - choices:
          - 'off'
          - flexible
          - full
          - strict
          multiple: false
          name: value
          type: choice
      items:
        type: object
    dns-records_DNSKEYRecord:
      allOf:
      - properties:
          content:
            type: string
            description: Formatted DNSKEY content. See 'data' to set DNSKEY properties.
            readOnly: true
          data:
            type: object
            description: Components of a DNSKEY record.
            properties:
              algorithm:
                type: number
                description: Algorithm.
                example: 5
                minimum: 0
                maximum: 255
              flags:
                type: number
                description: Flags.
                example: 1
                minimum: 0
                maximum: 65535
              protocol:
                type: number
                description: Protocol.
                example: 3
                minimum: 0
                maximum: 255
              public_key:
                type: string
                description: Public Key.
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - DNSKEY
            example: DNSKEY
      - $ref: '#/components/schemas/dns-records_base'
      title: DNSKEY Record
      required:
      - type
      - name
      - data
    workers_wasm_module_binding:
      type: object
      required:
      - name
      - type
      properties:
        name:
          $ref: '#/components/schemas/workers_binding_name'
        type:
          type: string
          description: The class of resource that the binding provides.
          enum:
          - wasm_module
          example: wasm_module
    access_schemas-isolation_required:
      type: boolean
      description: Require this application to be served in an isolated browser for users matching this policy.
      default: false
      example: false
    dns_dns_analytics_api_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    custom-pages_url:
      type: string
      format: uri
      description: The URL associated with the custom page.
      default: ''
      example: http://www.example.com
    zaraz_zaraz-config-return:
      allOf:
      - $ref: '#/components/schemas/zaraz_zaraz-config-base'
      - properties:
          tools:
            type: object
            description: Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID and value is the tool configuration object.
    zones_setting:
      oneOf:
      - $ref: '#/components/schemas/zones_0rtt'
      - $ref: '#/components/schemas/zones_advanced_ddos'
      - $ref: '#/components/schemas/zones_always_online'
      - $ref: '#/components/schemas/zones_always_use_https'
      - $ref: '#/components/schemas/zones_automatic_https_rewrites'
      - $ref: '#/components/schemas/zones_brotli'
      - $ref: '#/components/schemas/zones_browser_cache_ttl'
      - $ref: '#/components/schemas/zones_browser_check'
      - $ref: '#/components/schemas/zones_cache_level'
      - $ref: '#/components/schemas/zones_challenge_ttl'
      - $ref: '#/components/schemas/zones_ciphers'
      - $ref: '#/components/schemas/zones_cname_flattening'
      - $ref: '#/components/schemas/zones_development_mode'
      - $ref: '#/components/schemas/zones_early_hints'
      - $ref: '#/components/schemas/zones_edge_cache_ttl'
      - $ref: '#/components/schemas/zones_email_obfuscation'
      - $ref: '#/components/schemas/zones_h2_prioritization'
      - $ref: '#/components/schemas/zones_hotlink_protection'
      - $ref: '#/components/schemas/zones_http2'
      - $ref: '#/components/schemas/zones_http3'
      - $ref: '#/components/schemas/zones_image_resizing'
      - $ref: '#/components/schemas/zones_ip_geolocation'
      - $ref: '#/components/schemas/zones_ipv6'
      - $ref: '#/components/schemas/zones_max_upload'
      - $ref: '#/components/schemas/zones_min_tls_version'
      - $ref: '#/components/schemas/zones_minify'
      - $ref: '#/components/schemas/zones_mirage'
      - $ref: '#/components/schemas/zones_mobile_redirect'
      - $ref: '#/components/schemas/zones_nel'
      - $ref: '#/components/schemas/zones_opportunistic_encryption'
      - $ref: '#/components/schemas/zones_opportunistic_onion'
      - $ref: '#/components/schemas/zones_orange_to_orange'
      - $ref: '#/components/schemas/zones_origin_error_page_pass_thru'
      - $ref: '#/components/schemas/zones_polish'
      - $ref: '#/components/schemas/zones_prefetch_preload'
      - $ref: '#/components/schemas/zones_proxy_read_timeout'
      - $ref: '#/components/schemas/zones_pseudo_ipv4'
      - $ref: '#/components/schemas/zones_response_buffering'
      - $ref: '#/components/schemas/zones_rocket_loader'
      - $ref: '#/components/schemas/zones_schemas-automatic_platform_optimization'
      - $ref: '#/components/schemas/zones_security_header'
      - $ref: '#/components/schemas/zones_security_level'
      - $ref: '#/components/schemas/zones_server_side_exclude'
      - $ref: '#/components/schemas/zones_sha1_support'
      - $ref: '#/components/schemas/zones_sort_query_string_for_cache'
      - $ref: '#/components/schemas/zones_ssl'
      - $ref: '#/components/schemas/zones_ssl_recommender'
      - $ref: '#/components/schemas/zones_tls_1_2_only'
      - $ref: '#/components/schemas/zones_tls_1_3'
      - $ref: '#/components/schemas/zones_tls_client_auth'
      - $ref: '#/components/schemas/zones_true_client_ip_header'
      - $ref: '#/components/schemas/zones_waf'
      - $ref: '#/components/schemas/zones_webp'
      - $ref: '#/components/schemas/zones_websockets'
      type: object
    legacy-jhs_anomaly_name:
      type: string
      description: The name of the WAF package.
      example: OWASP ModSecurity Core Rule Set
      readOnly: true
    tls-certificates-and-hostnames_country:
      type: string
      description: Country, provided by the CSR
      example: US
      readOnly: true
    cache_cache_reserve:
      allOf:
      - $ref: '#/components/schemas/cache_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - cache_reserve
            example: cache_reserve
      title: Cache Reserve
      description: 'Increase cache lifetimes by automatically storing all cacheable files into Cloudflare''s persistent object storage buckets. Requires Cache Reserve subscription. Note: using Tiered Cache with Cache Reserve is highly recommended to reduce Reserve operations costs. See the [developer docs](https://developers.cloudflare.com/cache/about/cache-reserve) for more information.'
    access_require:
      type: array
      description: Rules evaluated with an AND logical operator. To match a policy, a user must meet all of the Require rules.
      items:
        $ref: '#/components/schemas/access_rule'
    rulesets_RuleRequest:
      oneOf:
      - $ref: '#/components/schemas/rulesets_BlockRule'
      - $ref: '#/components/schemas/rulesets_ExecuteRule'
      - $ref: '#/components/schemas/rulesets_LogRule'
      - $ref: '#/components/schemas/rulesets_SkipRule'
      discriminator:
        propertyName: action
        mapping:
          block: '#/components/schemas/rulesets_BlockRule'
          execute: '#/components/schemas/rulesets_ExecuteRule'
          log: '#/components/schemas/rulesets_LogRule'
          skip: '#/components/schemas/rulesets_SkipRule'
    cache_cache_reserve_clear_response_value:
      properties:
        result:
          allOf:
          - $ref: '#/components/schemas/cache_cache_reserve_clear'
          - required:
            - state
            - start_ts
            properties:
              end_ts:
                $ref: '#/components/schemas/cache_cache_reserve_clear_end_ts'
              start_ts:
                $ref: '#/components/schemas/cache_cache_reserve_clear_start_ts'
              state:
                $ref: '#/components/schemas/cache_cache_reserve_clear_state'
    zones_ciphers:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - ciphers
            example: ciphers
          value:
            $ref: '#/components/schemas/zones_ciphers_value'
      title: Zone ciphers allowed for TLS termination
      description: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.
      default: []
    legacy-jhs_cidr_configuration:
      title: An IP address range configuration.
      properties:
        target:
          description: The configuration target. You must set the target to `ip_range` when specifying an IP address range in the rule.
          enum:
          - ip_range
          example: ip_range
        value:
          type: string
          description: The IP address range to match. You can only use prefix lengths `/16` and `/24` for IPv4 ranges, and prefix lengths `/32`, `/48`, and `/64` for IPv6 ranges.
          example: 198.51.100.4/16
    email_rule_tag:
      type: string
      description: Routing rule tag. (Deprecated, replaced by routing rule identifier)
      example: a7e6fb77503c41d8a7f3113c6918f10c
      readOnly: true
      deprecated: true
      maxLength: 32
    dweb-config_content_list_entry_content:
      type: string
      description: CID or content path of content to block.
      example: QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB
      maxLength: 500
    load-balancing_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
    access_approval_group:
      type: object
      description: A group of email addresses that can approve a temporary authentication request.
      required:
      - approvals_needed
      properties:
        approvals_needed:
          type: number
          description: The number of approvals needed to obtain access.
          example: 1
          minimum: 0
        email_addresses:
          type: array
          description: A list of emails that can approve the access request.
          example:
          - test@cloudflare.com
          - test2@cloudflare.com
          items: {}
        email_list_uuid:
          type: string
          description: The UUID of an re-usable email list.
    access_organizations_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/access_schemas-organizations'
    access_certificates_components-schemas-name:
      type: string
      description: The name of the certificate.
      example: Allow devs
    legacy-jhs_filters_components-schemas-id:
      type: string
      description: The unique identifier of the filter.
      example: 372e67954025e0ba6aaa6d586b9e0b61
      readOnly: true
      minLength: 32
      maxLength: 32
    tls-certificates-and-hostnames_custom_origin_server:
      type: string
      description: a valid hostname that’s been added to your DNS zone as an A, AAAA, or CNAME record.
      example: origin2.example.com
    access_purpose_justification_required:
      type: boolean
      description: Require users to enter a justification when they log in to the application.
      default: false
      example: true
    tls-certificates-and-hostnames_cloudflare_branding:
      type: boolean
      description: Whether or not to add Cloudflare Branding for the order.  This will add sni.cloudflaressl.com as the Common Name if set true.
      example: false
    zones_development_mode:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - development_mode
            example: development_mode
          time_remaining:
            type: number
            description: 'Value of the zone setting.

              Notes: The interval (in seconds) from when development mode expires (positive integer) or last expired (negative integer) for the domain. If development mode has never been enabled, this value is false.'
            example: 3600
            readOnly: true
          value:
            $ref: '#/components/schemas/zones_development_mode_value'
      title: Development Mode
      description: Development Mode temporarily allows you to enter development mode for your websites if you need to make changes to your site. This will bypass Cloudflare's accelerated cache and slow down your site, but is useful if you are making changes to cacheable content (like images, css, or JavaScript) and would like to see those changes right away. Once entered, development mode will last for 3 hours and then automatically toggle off.
    zones_schemas-api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/zones_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/zones_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate:
      type: string
      description: The hostname certificate.
      example: '--BEGIN CERTIFICATE--

        MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV

        BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX

        aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF

        MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50

        ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB

        CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1

        CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB

        KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5

        0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI

        dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2

        izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4

        9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI

        GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV

        BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF

        MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2

        2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP

        Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG

        SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq

        2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw

        YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=

        --END CERTIFICATE--

        '
    zones_schemas-modified_on:
      type: string
      format: date-time
      description: The timestamp of when the Page Rule was last modified.
      example: '2014-01-01T05:20:00.12345Z'
      readOnly: true
    observatory_count-response:
      allOf:
      - $ref: '#/components/schemas/observatory_api-response-single'
      - properties:
          result:
            type: object
            properties:
              count:
                type: number
                description: Number of items affected.
                example: 1
    waf-managed-rules_priority:
      type: string
      description: The order in which the individual WAF rule is executed within its rule group.
      readOnly: true
    tls-certificates-and-hostnames_components-schemas-created_at:
      type: string
      format: date-time
      description: This is the time the tls setting was originally created for this hostname.
      example: '2023-07-10T20:01:50.219171Z'
    access_schemas-onetimepin:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - properties:
          config:
            type: object
          type:
            enum:
            - onetimepin
      type: object
      title: One Time Pin
    access_schemas-policies:
      type: object
      properties:
        approval_groups:
          $ref: '#/components/schemas/access_approval_groups'
        approval_required:
          $ref: '#/components/schemas/access_approval_required'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        decision:
          $ref: '#/components/schemas/access_decision'
        exclude:
          $ref: '#/components/schemas/access_schemas-exclude'
        id:
          $ref: '#/components/schemas/access_uuid'
        include:
          $ref: '#/components/schemas/access_include'
        isolation_required:
          $ref: '#/components/schemas/access_schemas-isolation_required'
        name:
          $ref: '#/components/schemas/access_policies_components-schemas-name'
        precedence:
          $ref: '#/components/schemas/access_precedence'
        purpose_justification_prompt:
          $ref: '#/components/schemas/access_purpose_justification_prompt'
        purpose_justification_required:
          $ref: '#/components/schemas/access_purpose_justification_required'
        require:
          $ref: '#/components/schemas/access_schemas-require'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
    dweb-config_api-response-single:
      allOf:
      - $ref: '#/components/schemas/dweb-config_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
              nullable: true
            - type: string
              nullable: true
      type: object
    waitingroom_event_details_response:
      allOf:
      - $ref: '#/components/schemas/waitingroom_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/waitingroom_event_details_result'
    dns_dns_analytics_api_data:
      type: array
      description: Array with one row per combination of dimension values.
      items:
        type: object
        required:
        - dimensions
        properties:
          dimensions:
            type: array
            description: Array of dimension values, representing the combination of dimension values corresponding to this row.
            items:
              type: string
              description: Dimension value.
              example: NODATA
    dns-records_AAAARecord:
      allOf:
      - properties:
          content:
            type: string
            format: ipv6
            description: A valid IPv6 address.
            example: 2400:cb00:2049::1
          name:
            $ref: '#/components/schemas/dns-records_name'
          proxied:
            $ref: '#/components/schemas/dns-records_proxied'
          type:
            type: string
            description: Record type.
            enum:
            - AAAA
            example: AAAA
      - $ref: '#/components/schemas/dns-records_base'
      title: AAAA Record
      required:
      - type
      - name
      - content
    page-shield_get-zone-connection-response:
      allOf:
      - $ref: '#/components/schemas/page-shield_connection'
    healthchecks_timestamp:
      type: string
      format: date-time
      example: '2014-01-01T05:20:00.12345Z'
      readOnly: true
    legacy-jhs_components-schemas-action:
      type: string
      description: The action to apply to a matched request. The `log` action is only available on an Enterprise plan.
      enum:
      - block
      - challenge
      - js_challenge
      - managed_challenge
      - allow
      - log
      - bypass
      example: block
    bot-management_bm_subscription_config:
      allOf:
      - $ref: '#/components/schemas/bot-management_base_config'
      - properties:
          auto_update_model:
            $ref: '#/components/schemas/bot-management_auto_update_model'
          suppress_session_score:
            $ref: '#/components/schemas/bot-management_suppress_session_score'
      title: BM Enterprise Subscription
    waitingroom_event_details_custom_page_html:
      type: string
      example: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}'
    page-shield_list-zone-policies-response:
      allOf:
      - $ref: '#/components/schemas/page-shield_api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/page-shield_pageshield-policy'
    data-zone-analytics-api_fields_response:
      type: object
      properties:
        key:
          type: string
          example: value
    api-shield_validation_enabled:
      type: boolean
      description: Flag whether schema is enabled for validation.
    legacy-jhs_schemas-paused:
      type: boolean
      description: When true, indicates that the rule is currently paused.
      example: false
    access_name:
      type: string
      description: The name of your Zero Trust organization.
      example: Widget Corps Internal Applications
    tls-certificates-and-hostnames_fallback_origin_response:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            type: object
    dns-custom-nameservers_get_response:
      allOf:
      - $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
      - $ref: '#/components/schemas/dns-custom-nameservers_zone_metadata'
    email_email_settings_response_single:
      allOf:
      - $ref: '#/components/schemas/email_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/email_settings'
    legacy-jhs_schemas-response_single:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - type: object
        properties:
          result:
            type: object
    legacy-jhs_overrides_components-schemas-description:
      type: string
      description: An informative summary of the current URI-based WAF override.
      example: Enable Cloudflare Magento ruleset for shop.example.com
      nullable: true
      maxLength: 1024
    waitingroom_event_new_users_per_minute:
      type: integer
      description: If set, the event will override the waiting room's `new_users_per_minute` property while it is active. If null, the event will inherit it. This can only be set if the event's `total_active_users` property is also set.
      nullable: true
      minimum: 200
      maximum: 2147483647
    legacy-jhs_schemas-filter-response-single:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - type: object
        required:
        - result
        properties:
          result:
            oneOf:
            - allOf:
              - $ref: '#/components/schemas/legacy-jhs_filter'
              - type: object
                required:
                - id
                - expression
                - paused
            - nullable: true
    tls-certificates-and-hostnames_organizational_unit:
      type: string
      description: Organizational Unit, provided by the CSR
      example: Organizational Unit
      readOnly: true
    secondary-dns_enable_transfer_response:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/secondary-dns_enable_transfer_result'
    tls-certificates-and-hostnames_geo_restrictions:
      type: object
      description: Specify the region where your private key can be held locally for optimal TLS performance. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Options allow distribution to only to U.S. data centers, only to E.U. data centers, or only to highest security data centers. Default distribution is to all Cloudflare datacenters, for optimal performance.
      properties:
        label:
          enum:
          - us
          - eu
          - highest_security
          example: us
    data-zone-analytics-api_pageviews:
      type: object
      description: Breakdown of totals for pageviews.
      properties:
        all:
          type: integer
          description: The total number of pageviews served within the time range.
        search_engine:
          type: object
          description: A variable list of key/value pairs representing the search engine and number of hits.
          example:
            baidubot: 1345
            bingbot: 5372
            googlebot: 35272
            pingdom: 13435
    load-balancing_proxied:
      type: boolean
      description: Whether the hostname should be gray clouded (false) or orange clouded (true).
      default: false
      example: true
    cache_cache_reserve_clear_state:
      type: string
      description: The current state of the Cache Reserve Clear operation.
      enum:
      - In-progress
      - Completed
      example: In-progress
    load-balancing_components-schemas-enabled:
      type: boolean
      description: Whether to enable (the default) this load balancer.
      default: true
      example: true
    data-zone-analytics-api_totals_by_colo:
      type: object
      description: Breakdown of totals by data type.
      properties:
        bandwidth:
          $ref: '#/components/schemas/data-zone-analytics-api_bandwidth_by_colo'
        requests:
          $ref: '#/components/schemas/data-zone-analytics-api_requests_by_colo'
        since:
          $ref: '#/components/schemas/data-zone-analytics-api_since'
        threats:
          $ref: '#/components/schemas/data-zone-analytics-api_threats'
        until:
          $ref: '#/components/schemas/data-zone-analytics-api_until'
    tls-certificates-and-hostnames_certificate_status:
      type: string
      description: Current status of certificate.
      enum:
      - initializing
      - authorizing
      - active
      - expired
      - issuing
      - timing_out
      - pending_deployment
      example: active
    logpush_session_id:
      type: string
      description: Unique session id of the job.
      example: 99d471b1ca3c23cc8e30b6acec5db987
    zones_pagerule_response_single:
      allOf:
      - $ref: '#/components/schemas/zones_api-response-single'
      - properties:
          result:
            type: object
    access_create_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            properties:
              client_id:
                $ref: '#/components/schemas/access_client_id'
              client_secret:
                $ref: '#/components/schemas/access_client_secret'
              created_at:
                $ref: '#/components/schemas/access_timestamp'
              duration:
                $ref: '#/components/schemas/access_duration'
              id:
                description: The ID of the service token.
              name:
                $ref: '#/components/schemas/access_service-tokens_components-schemas-name'
              updated_at:
                $ref: '#/components/schemas/access_timestamp'
    access_schemas-feature_app_props:
      type: object
      required:
      - type
      properties:
        allowed_idps:
          $ref: '#/components/schemas/access_allowed_idps'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity'
        domain:
          $ref: '#/components/schemas/access_components-schemas-domain'
        name:
          $ref: '#/components/schemas/access_apps_components-schemas-name'
        session_duration:
          $ref: '#/components/schemas/access_schemas-session_duration'
        type:
          $ref: '#/components/schemas/access_type'
    access_skip_interstitial:
      type: boolean
      description: Enables automatic authentication through cloudflared.
      example: true
    tls-certificates-and-hostnames_fingerprint_sha256:
      type: string
      description: Unique identifier of the Client Certificate
      example: 256c24690243359fb8cf139a125bd05ebf1d968b71e4caf330718e9f5c8a89ea
      readOnly: true
    legacy-jhs_analytics-aggregate_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-common'
      - properties:
          result:
            type: array
            items:
              type: object
    waitingroom_preview_url:
      type: string
      description: URL where the custom waiting room page can temporarily be previewed.
      example: http://waitingrooms.dev/preview/35af8c12-6d68-4608-babb-b53435a5ddfb
    tls-certificates-and-hostnames_ssl_verification_response_collection:
      allOf:
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_verification'
    legacy-jhs_components-schemas-priority:
      type: number
      description: The relative priority of the current URI-based WAF override when multiple overrides match a single URL. A lower number indicates higher priority. Higher priority overrides may overwrite values set by lower priority overrides.
      example: 1
      minimum: -1000000000
      maximum: 1000000000
    legacy-jhs_configurations:
      anyOf:
      - $ref: '#/components/schemas/legacy-jhs_schemas-ip_configuration'
      - $ref: '#/components/schemas/legacy-jhs_schemas-cidr_configuration'
      type: array
      description: A list of IP addresses or CIDR ranges that will be allowed to access the URLs specified in the Zone Lockdown rule. You can include any number of `ip` or `ip_range` configurations.
      items:
        anyOf:
        - $ref: '#/components/schemas/legacy-jhs_schemas-ip_configuration'
        - $ref: '#/components/schemas/legacy-jhs_schemas-cidr_configuration'
    load-balancing_load-balancer:
      type: object
      properties:
        adaptive_routing:
          $ref: '#/components/schemas/load-balancing_adaptive_routing'
        country_pools:
          $ref: '#/components/schemas/load-balancing_country_pools'
        created_on:
          $ref: '#/components/schemas/load-balancing_timestamp'
        default_pools:
          $ref: '#/components/schemas/load-balancing_default_pools'
        description:
          $ref: '#/components/schemas/load-balancing_components-schemas-description'
        enabled:
          $ref: '#/components/schemas/load-balancing_components-schemas-enabled'
        fallback_pool:
          $ref: '#/components/schemas/load-balancing_fallback_pool'
        id:
          $ref: '#/components/schemas/load-balancing_load-balancer_components-schemas-identifier'
        location_strategy:
          $ref: '#/components/schemas/load-balancing_location_strategy'
        modified_on:
          $ref: '#/components/schemas/load-balancing_timestamp'
        name:
          $ref: '#/components/schemas/load-balancing_components-schemas-name'
        pop_pools:
          $ref: '#/components/schemas/load-balancing_pop_pools'
        proxied:
          $ref: '#/components/schemas/load-balancing_proxied'
        random_steering:
          $ref: '#/components/schemas/load-balancing_random_steering'
        region_pools:
          $ref: '#/components/schemas/load-balancing_region_pools'
        rules:
          $ref: '#/components/schemas/load-balancing_rules'
        session_affinity:
          $ref: '#/components/schemas/load-balancing_session_affinity'
        session_affinity_attributes:
          $ref: '#/components/schemas/load-balancing_session_affinity_attributes'
        session_affinity_ttl:
          $ref: '#/components/schemas/load-balancing_session_affinity_ttl'
        steering_policy:
          $ref: '#/components/schemas/load-balancing_steering_policy'
        ttl:
          $ref: '#/components/schemas/load-balancing_ttl'
    waitingroom_query_preview:
      type: object
      required:
      - custom_html
      properties:
        custom_html:
          $ref: '#/components/schemas/waitingroom_custom_page_html'
    waitingroom_queue_all:
      type: boolean
      description: If queue_all is `true`, all the traffic that is coming to a route will be sent to the waiting room. No new traffic can get to the route once this field is set and estimated time will become unavailable.
      default: false
      example: true
    tls-certificates-and-hostnames_common_name:
      type: string
      description: Common Name of the Client Certificate
      example: Cloudflare
      readOnly: true
    api-shield_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    dns-records_tags:
      type: array
      description: Custom tags for the DNS record. This field has no effect on DNS responses.
      items:
        type: string
        description: Individual tag of the form name:value (the name must consist of only letters, numbers, underscores and hyphens)
        example: owner:dns-team
    zones_pagerule_settings_response_collection:
      allOf:
      - $ref: '#/components/schemas/zones_schemas-api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/zones_settings'
    zones_ip_geolocation_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'on'
    observatory_page_test:
      type: object
      properties:
        date:
          $ref: '#/components/schemas/observatory_timestamp'
        desktopReport:
          $ref: '#/components/schemas/observatory_lighthouse_report'
        id:
          $ref: '#/components/schemas/observatory_uuid'
        mobileReport:
          $ref: '#/components/schemas/observatory_lighthouse_report'
        region:
          $ref: '#/components/schemas/observatory_labeled_region'
        scheduleFrequency:
          $ref: '#/components/schemas/observatory_schedule_frequency'
        url:
          $ref: '#/components/schemas/observatory_url'
    bill-subs-api_price:
      type: number
      description: The price of the subscription that will be billed, in US dollars.
      example: 20
      readOnly: true
    zones_always_online_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'on'
    logpush_filter:
      type: string
      description: Filters to drill down into specific events.
      example: '{"where":{"and":[{"key":"ClientCountry","operator":"neq","value":"ca"}]}}'
    access_same_site_cookie_attribute:
      type: string
      description: Sets the SameSite cookie setting, which provides increased security against CSRF attacks.
      example: strict
    tls-certificates-and-hostnames_hostname_associations_response:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_association'
    bot-management_config_single:
      oneOf:
      - $ref: '#/components/schemas/bot-management_bot_fight_mode_config'
      - $ref: '#/components/schemas/bot-management_sbfm_definitely_config'
      - $ref: '#/components/schemas/bot-management_sbfm_likely_config'
      - $ref: '#/components/schemas/bot-management_bm_subscription_config'
      type: object
    zones_challenge_ttl_value:
      type: number
      description: Value of the zone setting.
      enum:
      - 300
      - 900
      - 1800
      - 2700
      - 3600
      - 7200
      - 10800
      - 14400
      - 28800
      - 57600
      - 86400
      - 604800
      - 2592000
      - 31536000
      default: 1800
    tls-certificates-and-hostnames_verification_errors:
      type: array
      description: These are errors that were encountered while trying to activate a hostname.
      example:
      - None of the A or AAAA records are owned by this account and the pre-generated ownership verification token was not found.
      items: {}
    rulesets_UpdateRulesetRequest:
      allOf:
      - $ref: '#/components/schemas/rulesets_Ruleset'
      - required:
        - rules
        properties:
          rules:
            $ref: '#/components/schemas/rulesets_RulesRequest'
    rulesets_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/rulesets_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/rulesets_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    zones_email_obfuscation_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'on'
    dnssec_dnssec_presigned:
      type: boolean
      description: 'If true, allows Cloudflare to transfer in a DNSSEC-signed zone

        including signatures from an external provider, without requiring

        Cloudflare to sign any records on the fly.


        Note that this feature has some limitations.

        See [Cloudflare as Secondary](https://developers.cloudflare.com/dns/zone-setups/zone-transfers/cloudflare-as-secondary/setup/#dnssec) for details.'
      example: true
    dns-records_per_page:
      type: number
      description: Number of DNS records per page.
      default: 100
      minimum: 5
      maximum: 50000
    access_github_organization_rule:
      type: object
      title: Github organization
      description: 'Matches a Github organization.

        Requires a Github identity provider.'
      required:
      - github-organization
      properties:
        github-organization:
          type: object
          required:
          - name
          - connection_id
          properties:
            connection_id:
              type: string
              description: The ID of your Github identity provider.
              example: ea85612a-29c8-46c2-bacb-669d65136971
            name:
              type: string
              description: The name of the organization.
              example: cloudflare
    logpush_validate_ownership_response:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            properties:
              valid:
                type: boolean
                example: true
    load-balancing_load-balancer_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/load-balancing_load-balancer'
    page-shield_version:
      type: object
      description: The version of the analyzed script.
      properties:
        fetched_at:
          $ref: '#/components/schemas/page-shield_fetched_at'
        hash:
          $ref: '#/components/schemas/page-shield_hash'
        js_integrity_score:
          $ref: '#/components/schemas/page-shield_js_integrity_score'
    tls-certificates-and-hostnames_cert_id:
      type: string
      description: Certificate identifier tag.
      example: 2458ce5a-0c35-4c7f-82c7-8e9487d3ff60
      maxLength: 36
    tls-certificates-and-hostnames_dcv_delegation_response:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            allOf:
            - $ref: '#/components/schemas/tls-certificates-and-hostnames_uuidObject'
            type: object
    tls-certificates-and-hostnames_uuidObject:
      properties:
        uuid:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_uuid'
    workers_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/workers_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/workers_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    access_fingerprint:
      type: string
      description: The MD5 fingerprint of the certificate.
      example: MD5 Fingerprint=1E:80:0F:7A:FD:31:55:96:DE:D5:CB:E2:F0:91:F6:91
    rulesets_Response:
      type: object
      title: Response
      description: A response object.
      required:
      - result
      - success
      - errors
      - messages
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/rulesets_Errors'
          - enum:
            - []
        messages:
          $ref: '#/components/schemas/rulesets_Messages'
        result:
          title: Result
          description: A result.
        success:
          type: boolean
          title: Success
          description: Whether the API call was successful.
          enum:
          - true
    dnssec_key_type:
      type: string
      description: Algorithm key type.
      example: ECDSAP256SHA256
      nullable: true
      readOnly: true
    zones_http3:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - http3
            example: http3
          value:
            $ref: '#/components/schemas/zones_http3_value'
      title: HTTP3 Value
      description: HTTP3 enabled for this zone.
    api-shield_single_response:
      allOf:
      - $ref: '#/components/schemas/api-shield_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/api-shield_configuration'
    access_certificate_rule:
      type: object
      title: Valid certificate
      description: Matches any valid client certificate.
      example:
        certificate: {}
      required:
      - certificate
      properties:
        certificate:
          type: object
          example: {}
    tls-certificates-and-hostnames_bundle_method:
      type: string
      description: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.
      enum:
      - ubiquitous
      - optimal
      - force
      default: ubiquitous
      example: ubiquitous
    waitingroom_waitingroom:
      type: object
      properties:
        additional_routes:
          $ref: '#/components/schemas/waitingroom_additional_routes'
        cookie_attributes:
          $ref: '#/components/schemas/waitingroom_cookie_attributes'
        cookie_suffix:
          $ref: '#/components/schemas/waitingroom_cookie_suffix'
        created_on:
          $ref: '#/components/schemas/waitingroom_timestamp'
        custom_page_html:
          $ref: '#/components/schemas/waitingroom_custom_page_html'
        default_template_language:
          $ref: '#/components/schemas/waitingroom_default_template_language'
        description:
          $ref: '#/components/schemas/waitingroom_description'
        disable_session_renewal:
          $ref: '#/components/schemas/waitingroom_disable_session_renewal'
        host:
          $ref: '#/components/schemas/waitingroom_host'
        id:
          $ref: '#/components/schemas/waitingroom_waiting_room_id'
        json_response_enabled:
          $ref: '#/components/schemas/waitingroom_json_response_enabled'
        modified_on:
          $ref: '#/components/schemas/waitingroom_timestamp'
        name:
          $ref: '#/components/schemas/waitingroom_name'
        new_users_per_minute:
          $ref: '#/components/schemas/waitingroom_new_users_per_minute'
        next_event_prequeue_start_time:
          $ref: '#/components/schemas/waitingroom_next_event_prequeue_start_time'
        next_event_start_time:
          $ref: '#/components/schemas/waitingroom_next_event_start_time'
        path:
          $ref: '#/components/schemas/waitingroom_path'
        queue_all:
          $ref: '#/components/schemas/waitingroom_queue_all'
        queueing_method:
          $ref: '#/components/schemas/waitingroom_queueing_method'
        queueing_status_code:
          $ref: '#/components/schemas/waitingroom_queueing_status_code'
        session_duration:
          $ref: '#/components/schemas/waitingroom_session_duration'
        suspended:
          $ref: '#/components/schemas/waitingroom_suspended'
        total_active_users:
          $ref: '#/components/schemas/waitingroom_total_active_users'
    page-shield_use_connection_url_path:
      type: boolean
      description: When true, the paths associated with connections URLs will also be analyzed.
      example: true
    dweb-config_api-response-single-id:
      allOf:
      - $ref: '#/components/schemas/dweb-config_api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            required:
            - id
            properties:
              id:
                $ref: '#/components/schemas/dweb-config_identifier'
      type: object
    access_allowed_idps:
      type: array
      description: The identity providers your users can select when connecting to this application. Defaults to all IdPs configured in your account.
      items:
        type: string
        description: The identity providers selected for application.
        example: 699d98642c564d2e855e9661899b7252
    argo-config_response_single:
      allOf:
      - $ref: '#/components/schemas/argo-config_api-response-single'
      - type: object
        properties:
          result:
            type: object
    page-shield_hash:
      type: string
      description: The computed hash of the analyzed script.
      nullable: true
      minLength: 64
      maxLength: 64
    rulesets_response_model:
      type: object
      properties:
        available:
          $ref: '#/components/schemas/rulesets_available'
        enabled:
          $ref: '#/components/schemas/rulesets_enabled'
        id:
          $ref: '#/components/schemas/rulesets_id'
    bill-subs-api_schemas-price:
      type: number
      description: The amount you will be billed for this plan.
      example: 0
    api-shield_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    bill-subs-api_zone:
      type: object
      description: A simple zone object. May have null properties if not a zone subscription.
      properties:
        id:
          $ref: '#/components/schemas/bill-subs-api_identifier'
        name:
          $ref: '#/components/schemas/bill-subs-api_name'
    cache_cache_reserve_response_value:
      properties:
        result:
          allOf:
          - $ref: '#/components/schemas/cache_cache_reserve'
          - required:
            - value
            properties:
              value:
                $ref: '#/components/schemas/cache_cache_reserve_value'
    healthchecks_address:
      type: string
      description: The hostname or IP address of the origin server to run health checks on.
      example: www.example.com
    bill-subs-api_install_id:
      type: string
      description: app install id.
    zaraz_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/zaraz_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/zaraz_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    email_create_rule_properties:
      type: object
      required:
      - actions
      - matchers
      properties:
        actions:
          $ref: '#/components/schemas/email_rule_actions'
        enabled:
          $ref: '#/components/schemas/email_rule_enabled'
        matchers:
          $ref: '#/components/schemas/email_rule_matchers'
        name:
          $ref: '#/components/schemas/email_rule_name'
        priority:
          $ref: '#/components/schemas/email_rule_priority'
    rulesets_schemas-response_model:
      type: object
      properties:
        scope:
          $ref: '#/components/schemas/rulesets_scope'
        type:
          $ref: '#/components/schemas/rulesets_type'
    access_schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/access_id'
    data-zone-analytics-api_requests_by_colo:
      type: object
      description: Breakdown of totals for requests.
      properties:
        all:
          type: integer
          description: Total number of requests served.
        cached:
          type: integer
          description: Total number of cached requests served.
        country:
          type: object
          description: Key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country.
          example:
            AG: 37298
            GI: 293846
            US: 4181364
        http_status:
          type: object
          description: A variable list of key/value pairs where the key is a HTTP status code and the value is the number of requests with that code served.
          example:
            '200': 13496983
            '301': 283
            '400': 187936
            '402': 1828
            '404': 1293
        uncached:
          type: integer
          description: Total number of requests served from the origin.
    bill-subs-api_available-rate-plan:
      type: object
      properties:
        can_subscribe:
          $ref: '#/components/schemas/bill-subs-api_can_subscribe'
        currency:
          $ref: '#/components/schemas/bill-subs-api_currency'
        externally_managed:
          $ref: '#/components/schemas/bill-subs-api_externally_managed'
        frequency:
          $ref: '#/components/schemas/bill-subs-api_schemas-frequency'
        id:
          $ref: '#/components/schemas/bill-subs-api_identifier'
        is_subscribed:
          $ref: '#/components/schemas/bill-subs-api_is_subscribed'
        legacy_discount:
          $ref: '#/components/schemas/bill-subs-api_legacy_discount'
        legacy_id:
          $ref: '#/components/schemas/bill-subs-api_legacy_id'
        name:
          $ref: '#/components/schemas/bill-subs-api_schemas-name'
        price:
          $ref: '#/components/schemas/bill-subs-api_schemas-price'
    data-zone-analytics-api_timestamps:
      type: string
      description: 'By default, timestamps in responses are returned as Unix nanosecond integers. The `?timestamps=` argument can be set to change the format in which response timestamps are returned. Possible values are: `unix`, `unixnano`, `rfc3339`. Note that `unix` and `unixnano` return timestamps as integers; `rfc3339` returns timestamps as strings.'
      enum:
      - unix
      - unixnano
      - rfc3339
      default: unixnano
      example: unixnano
    waitingroom_name:
      type: string
      description: A unique name to identify the waiting room. Only alphanumeric characters, hyphens and underscores are allowed.
      example: production_webinar
    dns-records_dns-record:
      oneOf:
      - $ref: '#/components/schemas/dns-records_ARecord'
      - $ref: '#/components/schemas/dns-records_AAAARecord'
      - $ref: '#/components/schemas/dns-records_CAARecord'
      - $ref: '#/components/schemas/dns-records_CERTRecord'
      - $ref: '#/components/schemas/dns-records_CNAMERecord'
      - $ref: '#/components/schemas/dns-records_DNSKEYRecord'
      - $ref: '#/components/schemas/dns-records_DSRecord'
      - $ref: '#/components/schemas/dns-records_HTTPSRecord'
      - $ref: '#/components/schemas/dns-records_LOCRecord'
      - $ref: '#/components/schemas/dns-records_MXRecord'
      - $ref: '#/components/schemas/dns-records_NAPTRRecord'
      - $ref: '#/components/schemas/dns-records_NSRecord'
      - $ref: '#/components/schemas/dns-records_PTRRecord'
      - $ref: '#/components/schemas/dns-records_SMIMEARecord'
      - $ref: '#/components/schemas/dns-records_SRVRecord'
      - $ref: '#/components/schemas/dns-records_SSHFPRecord'
      - $ref: '#/components/schemas/dns-records_SVCBRecord'
      - $ref: '#/components/schemas/dns-records_TLSARecord'
      - $ref: '#/components/schemas/dns-records_TXTRecord'
      - $ref: '#/components/schemas/dns-records_URIRecord'
      type: object
      required:
      - id
      - type
      - name
      - content
      - proxiable
      - locked
      - zone_name
      - created_on
      - modified_on
    access_apps_components-schemas-response_collection-2:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/access_schemas-apps'
    api-shield_requests:
      type: integer
      description: The estimated number of requests covered by these calculations.
      readOnly: true
    healthchecks_failure_reason:
      type: string
      description: The current failure reason if status is unhealthy.
      example: ''
      readOnly: true
    access_allow_credentials:
      type: boolean
      description: When set to `true`, includes credentials (cookies, authorization headers, or TLS client certificates) with requests.
    access_groups_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/access_schemas-groups'
    cache-purge_Prefixes:
      type: object
      properties:
        prefixes:
          type: array
          example:
          - www.example.com/foo
          - images.example.com/bar/baz
          items:
            type: string
    cache_variants_response_value:
      properties:
        result:
          allOf:
          - $ref: '#/components/schemas/cache_variants'
          - required:
            - value
            properties:
              value:
                $ref: '#/components/schemas/cache_variants_value'
    healthchecks_healthchecks:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/healthchecks_address'
        check_regions:
          $ref: '#/components/schemas/healthchecks_check_regions'
        consecutive_fails:
          $ref: '#/components/schemas/healthchecks_consecutive_fails'
        consecutive_successes:
          $ref: '#/components/schemas/healthchecks_consecutive_successes'
        created_on:
          $ref: '#/components/schemas/healthchecks_timestamp'
        description:
          $ref: '#/components/schemas/healthchecks_description'
        failure_reason:
          $ref: '#/components/schemas/healthchecks_failure_reason'
        http_config:
          $ref: '#/components/schemas/healthchecks_http_config'
        id:
          $ref: '#/components/schemas/healthchecks_identifier'
        interval:
          $ref: '#/components/schemas/healthchecks_interval'
        modified_on:
          $ref: '#/components/schemas/healthchecks_timestamp'
        name:
          $ref: '#/components/schemas/healthchecks_name'
        retries:
          $ref: '#/components/schemas/healthchecks_retries'
        status:
          $ref: '#/components/schemas/healthchecks_status'
        suspended:
          $ref: '#/components/schemas/healthchecks_suspended'
        tcp_config:
          $ref: '#/components/schemas/healthchecks_tcp_config'
        timeout:
          $ref: '#/components/schemas/healthchecks_timeout'
        type:
          $ref: '#/components/schemas/healthchecks_type'
    dnssec_status:
      description: Status of DNSSEC, based on user-desired state and presence of necessary records.
      enum:
      - active
      - pending
      - disabled
      - pending-disabled
      - error
      example: active
    legacy-jhs_rule_single_id_response:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/legacy-jhs_rule_components-schemas-identifier'
    waf-managed-rules_schemas-group:
      allOf:
      - $ref: '#/components/schemas/waf-managed-rules_group'
      - properties:
          allowed_modes:
            $ref: '#/components/schemas/waf-managed-rules_allowed_modes'
          mode:
            $ref: '#/components/schemas/waf-managed-rules_mode'
      type: object
      required:
      - id
      - name
      - description
      - mode
      - rules_count
    tls-certificates-and-hostnames_per_hostname_settings_response_delete:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            allOf:
            - $ref: '#/components/schemas/tls-certificates-and-hostnames_settingObjectDelete'
            type: object
    dns-custom-nameservers_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/dns-custom-nameservers_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/dns-custom-nameservers_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    access_empty_response:
      allOf:
      - properties:
          result:
            type: boolean
            enum:
            - true
            - false
            example: true
          success:
            type: boolean
            enum:
            - true
            - false
            example: true
    access_schemas-onelogin:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            allOf:
            - $ref: '#/components/schemas/access_generic-oauth-config'
            - type: object
              properties:
                onelogin_account:
                  type: string
                  description: Your OneLogin account url
                  example: https://mycompany.onelogin.com
      type: object
      title: OneLogin
    logpush_logpush_job_response_collection:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-common'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/logpush_logpush_job'
    bot-management_base_config:
      allOf:
      - properties:
          enable_js:
            $ref: '#/components/schemas/bot-management_enable_js'
          using_latest_model:
            $ref: '#/components/schemas/bot-management_using_latest_model'
      title: Shared Config
    bill-subs-api_externally_managed:
      type: boolean
      description: Indicates whether this plan is managed externally.
      default: false
      example: false
    page-shield_pageshield-policy-id:
      type: string
      description: The ID of the policy
      example: c9ef84a6bf5e47138c75d95e2f933e8f
    rulesets_CreateRulesetRequest:
      allOf:
      - $ref: '#/components/schemas/rulesets_Ruleset'
      - required:
        - name
        - kind
        - phase
        - rules
        properties:
          rules:
            $ref: '#/components/schemas/rulesets_RulesRequest'
    access_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/access_service-tokens'
    bot-management_bot_fight_mode_config:
      allOf:
      - $ref: '#/components/schemas/bot-management_base_config'
      - properties:
          fight_mode:
            $ref: '#/components/schemas/bot-management_fight_mode'
      title: Bot Fight Mode
    cache_patch:
      type: object
      description: Update enablement of Tiered Caching
      required:
      - value
      properties:
        value:
          $ref: '#/components/schemas/cache_value'
    dns-records_name:
      type: string
      description: DNS record name (or @ for the zone apex) in Punycode.
      example: example.com
      maxLength: 255
    access_schemas-ssh_props:
      allOf:
      - $ref: '#/components/schemas/access_schemas-self_hosted_props'
      - properties:
          type:
            type: string
            description: The application type.
            example: ssh
    legacy-jhs_rules:
      type: object
      description: An object that allows you to override the action of specific WAF rules. Each key of this object must be the ID of a WAF rule, and each value must be a valid WAF action. Unless you are disabling a rule, ensure that you also enable the rule group that this WAF rule belongs to. When creating a new URI-based WAF override, you must provide a `groups` object or a `rules` object.
      example:
        '100015': disable
    zones_opportunistic_encryption:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - opportunistic_encryption
            example: opportunistic_encryption
          value:
            $ref: '#/components/schemas/zones_opportunistic_encryption_value'
      title: Enable Opportunistic Encryption for a zone
      description: Enables the Opportunistic Encryption feature for a zone.
    access_schemas-centrify:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            allOf:
            - $ref: '#/components/schemas/access_generic-oauth-config'
            - type: object
              properties:
                centrify_account:
                  type: string
                  description: Your centrify account url
                  example: https://abc123.my.centrify.com/
                centrify_app_id:
                  type: string
                  description: Your centrify app id
                  example: exampleapp
      type: object
      title: Centrify
    dns-records_SMIMEARecord:
      allOf:
      - properties:
          content:
            type: string
            description: Formatted SMIMEA content. See 'data' to set SMIMEA properties.
            readOnly: true
          data:
            type: object
            description: Components of a SMIMEA record.
            properties:
              certificate:
                type: string
                description: Certificate.
              matching_type:
                type: number
                description: Matching Type.
                example: 0
                minimum: 0
                maximum: 255
              selector:
                type: number
                description: Selector.
                example: 0
                minimum: 0
                maximum: 255
              usage:
                type: number
                description: Usage.
                example: 3
                minimum: 0
                maximum: 255
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - SMIMEA
            example: SMIMEA
      - $ref: '#/components/schemas/dns-records_base'
      title: SMIMEA Record
      required:
      - type
      - name
      - data
    observatory_timestamp:
      type: string
      format: date-time
      example: '2014-01-01T05:20:00.12345Z'
      readOnly: true
    legacy-jhs_egs-pagination:
      type: object
      properties:
        page:
          type: number
          description: The page number of paginated results.
          default: 1
          minimum: 1
        per_page:
          type: number
          description: The maximum number of results per page. You can only set the value to `1` or to a multiple of 5 such as `5`, `10`, `15`, or `20`.
          default: 20
          minimum: 1
          maximum: 1000
    waitingroom_next_event_prequeue_start_time:
      type: string
      description: An ISO 8601 timestamp that marks when the next event will begin queueing.
      example: '2021-09-28T15:00:00.000Z'
      nullable: true
    data-zone-analytics-api_threats:
      type: object
      description: Breakdown of totals for threats.
      properties:
        all:
          type: integer
          description: The total number of identifiable threats received over the time frame.
        country:
          type: object
          description: A list of key/value pairs where the key is a two-digit country code and the value is the number of malicious requests received from that country.
          example:
            AU: 91
            CN: 523423
            US: 123
        type:
          type: object
          description: The list of key/value pairs where the key is a threat category and the value is the number of requests.
          example:
            hot.ban.unknown: 5324
            macro.chl.captchaErr: 1341
            macro.chl.jschlErr: 5323
            user.ban.ip: 123
    dns-records_order:
      type: string
      description: Field to order DNS records by.
      enum:
      - type
      - name
      - content
      - ttl
      - proxied
      default: type
    bot-management_sbfm_definitely_automated:
      type: string
      description: Super Bot Fight Mode (SBFM) action to take on definitely automated requests.
      enum:
      - allow
      - block
      - managed_challenge
      example: allow
    waitingroom_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/waitingroom_schemas-api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/waitingroom_result_info'
      type: object
    waitingroom_event_response_collection:
      allOf:
      - $ref: '#/components/schemas/waitingroom_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/waitingroom_event_result'
    workers_pattern:
      type: string
      title: Route pattern
      example: example.net/*
    zones_true_client_ip_header:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - true_client_ip_header
            example: true_client_ip_header
          value:
            $ref: '#/components/schemas/zones_true_client_ip_header_value'
      title: True Client IP Header
      description: Allows customer to continue to use True Client IP (Akamai feature) in the headers we send to the origin. This is limited to Enterprise Zones.
      default: 'off'
    zones_sort_query_string_for_cache:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - sort_query_string_for_cache
            example: sort_query_string_for_cache
          value:
            $ref: '#/components/schemas/zones_sort_query_string_for_cache_value'
      title: Get String Sort
      description: Cloudflare will treat files with the same query strings as the same file in cache, regardless of the order of the query strings. This is limited to Enterprise Zones.
      default: 'off'
    dns-records_type:
      type: string
      description: Record type.
      enum:
      - A
      - AAAA
      - CAA
      - CERT
      - CNAME
      - DNSKEY
      - DS
      - HTTPS
      - LOC
      - MX
      - NAPTR
      - NS
      - PTR
      - SMIMEA
      - SRV
      - SSHFP
      - SVCB
      - TLSA
      - TXT
      - URI
      example: A
    dns_dns_analytics_api_dimensions:
      type: string
      description: A comma-separated list of dimensions to group results by.
      example: queryType
    dnssec_digest_algorithm:
      type: string
      description: Type of digest algorithm.
      example: SHA256
      nullable: true
      readOnly: true
    access_basic_app_response_props:
      type: object
      properties:
        aud:
          $ref: '#/components/schemas/access_schemas-aud'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        id:
          $ref: '#/components/schemas/access_uuid'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
    rulesets_BlockRule:
      allOf:
      - $ref: '#/components/schemas/rulesets_Rule'
      - title: Block rule
        properties:
          action:
            enum:
            - block
          action_parameters:
            properties:
              response:
                type: object
                title: Response
                description: The response to show when the block is applied.
                required:
                - status_code
                - content
                - content_type
                properties:
                  content:
                    type: string
                    title: Content
                    description: The content to return.
                    example: "{\n  \"success\": false,\n  \"error\": \"you have been blocked\"\n}"
                    minLength: 1
                  content_type:
                    type: string
                    title: Content type
                    description: The type of the content to return.
                    example: application/json
                    minLength: 1
                  status_code:
                    type: integer
                    title: Status code
                    description: The status code to return.
                    minimum: 400
                    maximum: 499
          description:
            example: Block when the IP address is not 1.1.1.1
    waf-managed-rules_components-schemas-identifier:
      type: string
      description: The unique identifier of the rule group.
      example: de677e5818985db1285d0e80225f06e5
      readOnly: true
      maxLength: 32
    api-shield_discovery_operation:
      allOf:
      - required:
        - id
        - last_updated
        - state
        - origin
        properties:
          features:
            anyOf:
            - $ref: '#/components/schemas/api-shield_traffic_stats'
            type: object
          id:
            $ref: '#/components/schemas/api-shield_uuid'
          last_updated:
            $ref: '#/components/schemas/api-shield_timestamp'
          origin:
            type: array
            description: API discovery engine(s) that discovered this operation
            items:
              $ref: '#/components/schemas/api-shield_api_discovery_origin'
          state:
            $ref: '#/components/schemas/api-shield_api_discovery_state'
      - $ref: '#/components/schemas/api-shield_basic_operation'
      type: object
    email_email_setting_identifier:
      type: string
      description: Email Routing settings identifier.
      example: 75610dab9e69410a82cf7e400a09ecec
      readOnly: true
      maxLength: 32
    legacy-jhs_lockdowns_components-schemas-priority:
      type: number
      description: The priority of the rule to control the processing order. A lower number indicates higher priority. If not provided, any rules with a configured priority will be processed before rules without a priority.
      example: 5
    data-zone-analytics-api_ray_identifier:
      type: string
      description: Ray identifier.
      example: 41ddf1740f67442d
      readOnly: true
      maxLength: 16
    legacy-jhs_schemas-urls:
      type: array
      description: The URLs to include in the rule definition. You can use wildcards. Each entered URL will be escaped before use, which means you can only use simple wildcard patterns.
      items:
        type: string
        example: api.mysite.com/some/endpoint*
    tls-certificates-and-hostnames_schemas-created_at:
      type: string
      format: date-time
      description: The time when the certificate was created.
      example: '2100-01-01T05:20:00Z'
      readOnly: true
    secondary-dns_auto_refresh_seconds:
      type: number
      description: 'How often should a secondary zone auto refresh regardless of DNS NOTIFY.

        Not applicable for primary zones.'
      example: 86400
    access_custom_deny_message:
      type: string
      description: The custom error message shown to a user when they are denied access to the application.
    tls-certificates-and-hostnames_keyless_private_ip:
      type: string
      description: Private IP of the Key Server Host
      example: 10.0.0.1
    access_ca_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            type: object
    api-shield_patch_discoveries_response:
      allOf:
      - $ref: '#/components/schemas/api-shield_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/api-shield_api_discovery_patch_multiple_request'
    cache_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/cache_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/cache_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    dns_dns_analytics_api_report:
      allOf:
      - $ref: '#/components/schemas/dns_dns_analytics_api_result'
      - required:
        - data
        properties:
          data:
            items:
              required:
              - metrics
              properties:
                metrics:
                  type: array
                  description: Array with one item per requested metric. Each item is a single value.
                  items:
                    type: number
                    description: Nominal metric value.
    zones_email_obfuscation:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - email_obfuscation
            example: email_obfuscation
          value:
            $ref: '#/components/schemas/zones_email_obfuscation_value'
      title: Email Obfuscation
      description: Encrypt email adresses on your web page from bots, while keeping them visible to humans. (https://support.cloudflare.com/hc/en-us/articles/200170016).
    page-shield_zone_settings_response_single:
      allOf:
      - $ref: '#/components/schemas/page-shield_api-response-single'
      - properties:
          result:
            type: object
    waf-managed-rules_rule:
      oneOf:
      - $ref: '#/components/schemas/waf-managed-rules_anomaly_rule'
      - $ref: '#/components/schemas/waf-managed-rules_traditional_deny_rule'
      - $ref: '#/components/schemas/waf-managed-rules_traditional_allow_rule'
      type: object
    secondary-dns_dns-secondary-secondary-zone:
      type: object
      required:
      - id
      - name
      - peers
      - auto_refresh_seconds
      properties:
        auto_refresh_seconds:
          $ref: '#/components/schemas/secondary-dns_auto_refresh_seconds'
        id:
          $ref: '#/components/schemas/secondary-dns_identifier'
        name:
          $ref: '#/components/schemas/secondary-dns_name'
        peers:
          $ref: '#/components/schemas/secondary-dns_peers'
    zones_max_upload:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: identifier of the zone setting.
            enum:
            - max_upload
            example: max_upload
          value:
            $ref: '#/components/schemas/zones_max_upload_value'
      title: Max Upload
      description: Maximum size of an allowable upload.
    healthchecks_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    legacy-jhs_header_value:
      type: string
      description: The value of the response header, which must match exactly.
      example: HIT
    rulesets_RulesRequest:
      type: array
      title: Rules
      description: The list of rules in the ruleset.
      items:
        $ref: '#/components/schemas/rulesets_RuleRequest'
    dnssec_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/dnssec_messages'
        messages:
          $ref: '#/components/schemas/dnssec_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    cache_regional_tiered_cache_value:
      type: string
      description: Value of the Regional Tiered Cache zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    legacy-jhs_period:
      type: number
      description: The time in seconds (an integer value) to count matching traffic. If the count exceeds the configured threshold within this period, Cloudflare will perform the configured action.
      example: 900
      minimum: 10
      maximum: 86400
    bill-subs-api_schemas-identifier:
      type: string
      description: Subscription identifier tag.
      example: 506e3185e9c882d175a2d0cb0093d9f2
      readOnly: true
      maxLength: 32
    zones_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/zones_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/zones_messages'
          example: []
        result:
          type: object
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          example: false
    cache_origin_max_http_version_response_value:
      properties:
        result:
          allOf:
          - $ref: '#/components/schemas/cache_origin_max_http_version'
          - required:
            - value
            properties:
              value:
                $ref: '#/components/schemas/cache_origin_max_http_version_value'
    email_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/email_messages'
        messages:
          $ref: '#/components/schemas/email_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    data-zone-analytics-api_totals:
      type: object
      description: Breakdown of totals by data type.
      properties:
        bandwidth:
          $ref: '#/components/schemas/data-zone-analytics-api_bandwidth'
        pageviews:
          $ref: '#/components/schemas/data-zone-analytics-api_pageviews'
        requests:
          $ref: '#/components/schemas/data-zone-analytics-api_requests'
        since:
          $ref: '#/components/schemas/data-zone-analytics-api_since'
        threats:
          $ref: '#/components/schemas/data-zone-analytics-api_threats'
        uniques:
          $ref: '#/components/schemas/data-zone-analytics-api_uniques'
        until:
          $ref: '#/components/schemas/data-zone-analytics-api_until'
    dns-records_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/dns-records_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/dns-records_result_info'
      type: object
    waitingroom_max_estimated_time_minutes:
      type: integer
    waitingroom_rule_id:
      type: string
      description: The ID of the rule.
      example: 25756b2dfe6e378a06b033b670413757
    legacy-jhs_detection_mode:
      type: string
      description: The mode that defines how rules within the package are evaluated during the course of a request. When a package uses anomaly detection mode (`anomaly` value), each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined in the WAF package, the action configured in the package will be performed. Traditional detection mode (`traditional` value) will decide the action to take when it is triggered by the request. If multiple rules are triggered, the action providing the highest protection will be applied (for example, a 'block' action will win over a 'challenge' action).
      enum:
      - anomaly
      - traditional
      example: traditional
      readOnly: true
    load-balancing_session_affinity:
      type: string
      description: 'Specifies the type of session affinity the load balancer should use unless specified as `"none"` or "" (default). The supported types are:

        - `"cookie"`: On the first request to a proxied load balancer, a cookie is generated, encoding information of which origin the request will be forwarded to. Subsequent requests, by the same client to the same load balancer, will be sent to the origin server the cookie encodes, for the duration of the cookie and as long as the origin server remains healthy. If the cookie has expired or the origin server is unhealthy, then a new origin server is calculated and used.

        - `"ip_cookie"`: Behaves the same as `"cookie"` except the initial origin selection is stable and based on the client''s ip address.

        - `"header"`: On the first request to a proxied load balancer, a session key based on the configured HTTP headers (see `session_affinity_attributes.headers`) is generated, encoding the request headers used for storing in the load balancer session state which origin the request will be forwarded to. Subsequent requests to the load balancer with the same headers will be sent to the same origin server, for the duration of the session and as long as the origin server remains healthy. If the session has been idle for the duration of `session_affinity_ttl` seconds or the origin server is unhealthy, then a new origin server is calculated and used. See `headers` in `session_affinity_attributes` for additional required configuration.'
      enum:
      - none
      - cookie
      - ip_cookie
      - header
      - '""'
      default: '""'
      example: cookie
    zones_orange_to_orange_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'on'
    tls-certificates-and-hostnames_schemas-enabled:
      type: boolean
      description: 'Disabling Universal SSL removes any currently active Universal SSL certificates for your zone from the edge and prevents any future Universal SSL certificates from being ordered. If there are no advanced certificates or custom certificates uploaded for the domain, visitors will be unable to access the domain over HTTPS.


        By disabling Universal SSL, you understand that the following Cloudflare settings and preferences will result in visitors being unable to visit your domain unless you have uploaded a custom certificate or purchased an advanced certificate.


        * HSTS

        * Always Use HTTPS

        * Opportunistic Encryption

        * Onion Routing

        * Any Page Rules redirecting traffic to HTTPS


        Similarly, any HTTP redirect to HTTPS at the origin while the Cloudflare proxy is enabled will result in users being unable to visit your site without a valid certificate at Cloudflare''s edge.


        If you do not have a valid custom or advanced certificate at Cloudflare''s edge and are unsure if any of the above Cloudflare settings are enabled, or if any HTTP redirects exist at your origin, we advise leaving Universal SSL enabled for your domain.'
      example: true
    api-shield_schema_upload_response:
      type: object
      required:
      - schema
      properties:
        schema:
          $ref: '#/components/schemas/api-shield_public_schema'
        upload_details:
          $ref: '#/components/schemas/api-shield_schema_upload_details_warnings_only'
    api-shield_validation_default_mitigation_action:
      type: string
      description: "The default mitigation action used when there is no mitigation action defined on the operation\n\nMitigation actions are as follows:\n\n  * `log` - log request when request does not conform to schema\n  * `block` - deny access to the site when request does not conform to schema\n\nA special value of of `none` will skip running schema validation entirely for the request when there is no mitigation action defined on the operation\n"
      enum:
      - none
      - log
      - block
      example: block
    access_service_auth_401_redirect:
      type: boolean
      description: Returns a 401 status code when the request is blocked by a Service Auth policy.
      example: true
    waitingroom_create_rule:
      required:
      - action
      - expression
      properties:
        action:
          $ref: '#/components/schemas/waitingroom_rule_action'
        description:
          $ref: '#/components/schemas/waitingroom_rule_description'
        enabled:
          $ref: '#/components/schemas/waitingroom_rule_enabled'
        expression:
          $ref: '#/components/schemas/waitingroom_rule_expression'
    zones_ipv6:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - ipv6
            example: ipv6
          value:
            $ref: '#/components/schemas/zones_ipv6_value'
      title: IPv6
      description: Enable IPv6 on all subdomains that are Cloudflare enabled.  (https://support.cloudflare.com/hc/en-us/articles/200168586).
    tls-certificates-and-hostnames_settingObjectDelete:
      properties:
        created_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-created_at'
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname'
        status:
          example: pending_deletion
        updated_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-updated_at'
        value:
          example: ''
    zones_development_mode_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    email_rule_action:
      type: object
      description: Actions pattern.
      required:
      - type
      - value
      properties:
        type:
          type: string
          description: Type of supported action.
          enum:
          - drop
          - forward
          - worker
          example: forward
        value:
          type: array
          items:
            type: string
            description: Value for action.
            example: destinationaddress@example.net
            maxLength: 90
    access_allow_all_origins:
      type: boolean
      description: Allows all origins.
    zones_ssl_recommender_enabled:
      type: boolean
      description: ssl-recommender enrollment setting.
      default: false
    tls-certificates-and-hostnames_uuid:
      type: string
      description: The DCV Delegation unique identifier.
      example: abc123def456ghi7
    access_schemas-yandex:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            $ref: '#/components/schemas/access_generic-oauth-config'
      type: object
      title: Yandex
    workers_enabled:
      type: boolean
      title: Whether or not this filter will run a script
      example: true
    logpush_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/logpush_messages'
        messages:
          $ref: '#/components/schemas/logpush_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    tls-certificates-and-hostnames_private_key:
      type: string
      description: The zone's private key.
      example: '--BEGIN RSA PRIVATE KEY--

        MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG

        dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn

        abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid

        tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py

        FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE

        ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb

        HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/

        axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb

        +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g

        +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv

        KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7

        9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo

        /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu

        iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9

        N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe

        VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB

        vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U

        lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR

        9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7

        mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX

        dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe

        PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS

        fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W

        qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T

        lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi

        --END RSA PRIVATE KEY--

        '
    zones_url_target:
      type: object
      description: URL target.
      properties:
        constraint:
          allOf:
          - $ref: '#/components/schemas/zones_string_constraint'
          - properties:
              value:
                type: string
                description: The URL pattern to match against the current request. The pattern may contain up to four asterisks ('*') as placeholders.
                example: '*example.com/images/*'
                pattern: ^(https?://)?(([-a-zA-Z0-9*]*\.)+[-a-zA-Z0-9]{2,20})(:(8080|8443|443|80))?(/[\S]+)?$
          type: object
          description: The constraint of a target.
        target:
          description: A target based on the URL of the request.
          enum:
          - url
          example: url
    email_rule_catchall-matchers:
      type: array
      description: List of matchers for the catch-all routing rule.
      items:
        $ref: '#/components/schemas/email_rule_catchall-matcher'
    zones_security_header:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone's security header.
            enum:
            - security_header
            example: security_header
          value:
            $ref: '#/components/schemas/zones_security_header_value'
      title: Security Header
      description: Cloudflare security header for a zone.
    zones_http2:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - http2
            example: http2
          value:
            $ref: '#/components/schemas/zones_http2_value'
      title: HTTP2 Value
      description: HTTP2 enabled for this zone.
    tls-certificates-and-hostnames_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    rulesets_RulesetsResponse:
      type: array
      title: Rulesets
      description: A list of rulesets. The returned information will not include the rules in each ruleset.
      items:
        allOf:
        - $ref: '#/components/schemas/rulesets_Ruleset'
        - required:
          - name
          - kind
          - phase
    dns-records_PTRRecord:
      allOf:
      - properties:
          content:
            type: string
            description: Domain name pointing to the address.
            example: example.com
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - PTR
            example: PTR
      - $ref: '#/components/schemas/dns-records_base'
      title: PTR Record
      required:
      - type
      - name
      - content
    healthchecks_consecutive_fails:
      type: integer
      description: The number of consecutive fails required from a health check before changing the health to unhealthy.
      default: 1
    rulesets_RuleEnabled:
      type: boolean
      title: Enabled
      description: Whether the rule should be executed.
      example: true
    tls-certificates-and-hostnames_hostname_aop_response_collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull'
    tls-certificates-and-hostnames_components-schemas-status:
      description: Status of the hostname's activation.
      enum:
      - active
      - pending
      - active_redeploying
      - moved
      - pending_deletion
      - deleted
      - pending_blocked
      - pending_migration
      - pending_provisioned
      - test_pending
      - test_active
      - test_active_apex
      - test_blocked
      - test_failed
      - provisioned
      - blocked
      example: pending
    access_schemas-identity-provider:
      type: object
      required:
      - name
      - type
      - config
      properties:
        config:
          type: object
          description: The configuration parameters for the identity provider. To view the required parameters for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
        id:
          $ref: '#/components/schemas/access_uuid'
        name:
          $ref: '#/components/schemas/access_schemas-name'
        scim_config:
          type: object
          description: The configuration settings for enabling a System for Cross-Domain Identity Management (SCIM) with the identity provider.
          properties:
            enabled:
              type: boolean
              description: A flag to enable or disable SCIM for the identity provider.
            group_member_deprovision:
              type: boolean
              description: A flag to revoke a user's session in Access and force a reauthentication on the user's Gateway session when they have been added or removed from a group in the Identity Provider.
            seat_deprovision:
              type: boolean
              description: A flag to remove a user's seat in Zero Trust when they have been deprovisioned in the Identity Provider.  This cannot be enabled unless user_deprovision is also enabled.
            secret:
              type: string
              description: A read-only token generated when the SCIM integration is enabled for the first time.  It is redacted on subsequent requests. If you lose this you will need to refresh it token at /access/identity_providers/:idpID/refresh_scim_secret.
            user_deprovision:
              type: boolean
              description: A flag to enable revoking a user's session in Access and Gateway when they have been deprovisioned in the Identity Provider.
        type:
          type: string
          description: The type of identity provider. To determine the value for a specific provider, refer to our [developer documentation](https://developers.cloudflare.com/cloudflare-one/identity/idp-integration/).
          enum:
          - onetimepin
          - azureAD
          - saml
          - centrify
          - facebook
          - github
          - google-apps
          - google
          - linkedin
          - oidc
          - okta
          - onelogin
          - pingone
          - yandex
          example: onetimepin
    logpush_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    zones_webp_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'off'
      - 'on'
      default: 'off'
    data-zone-analytics-api_query_response:
      type: object
      description: The exact parameters/timestamps the analytics service used to return data.
      readOnly: true
      properties:
        since:
          $ref: '#/components/schemas/data-zone-analytics-api_since'
        time_delta:
          type: integer
          description: The amount of time (in minutes) that each data point in the timeseries represents. The granularity of the time-series returned (e.g. each bucket in the time series representing 1-minute vs 1-day) is calculated by the API based on the time-range provided to the API.
        until:
          $ref: '#/components/schemas/data-zone-analytics-api_until'
    secondary-dns_enable_transfer_result:
      type: string
      description: The zone transfer status of a primary zone
      example: Enabled
    zones_always_use_https_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    secondary-dns_force_result:
      type: string
      description: When force_axfr query parameter is set to true, the response is a simple string
      example: OK
    legacy-jhs_override_response_single:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - type: object
        required:
        - result
        properties:
          result:
            $ref: '#/components/schemas/legacy-jhs_override'
    zones_route:
      type: object
      properties:
        modified_on:
          type: string
          format: date-time
          description: The timestamp of when the override was last modified.
          example: '2014-01-01T05:20:00.12345Z'
          readOnly: true
        name:
          description: The type of route.
          enum:
          - forward_url
          example: forward_url
        value:
          properties:
            type:
              description: The response type for the URL redirect.
              enum:
              - temporary
              - permanent
              example: temporary
            url:
              type: string
              description: 'The URL to redirect the request to.

                Notes: ${num} refers to the position of ''*'' in the constraint value.'
              example: http://www.example.com/somewhere/$1/astring/$2/anotherstring/$3
    tls-certificates-and-hostnames_api-response-single:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    dweb-config_modify_request:
      type: object
      properties:
        description:
          $ref: '#/components/schemas/dweb-config_description'
        dnslink:
          $ref: '#/components/schemas/dweb-config_dnslink'
    dns-records_direction:
      type: string
      description: Direction to order DNS records in.
      enum:
      - asc
      - desc
      default: asc
    rulesets_response_list:
      type: array
      items:
        $ref: '#/components/schemas/rulesets_response_model'
    waitingroom_cookie_suffix:
      type: string
      description: Appends a '_' + a custom suffix to the end of Cloudflare Waiting Room's cookie name(__cf_waitingroom). If `cookie_suffix` is "abcd", the cookie name will be `__cf_waitingroom_abcd`. This field is required if using `additional_routes`.
      example: abcd
    tls-certificates-and-hostnames_client_certificate_response_single:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate'
    waf-managed-rules_default_mode:
      description: The default action/mode of a rule.
      enum:
      - disable
      - simulate
      - block
      - challenge
      example: block
      readOnly: true
    page-shield_js_integrity_score:
      type: integer
      description: The integrity score of the JavaScript content.
      nullable: true
      minimum: 1
      maximum: 99
    api-shield_p99:
      type: integer
      description: The p99 quantile of requests (in period_seconds).
      readOnly: true
    waf-managed-rules_rule_components-schemas-identifier:
      type: string
      description: The unique identifier of the WAF rule.
      example: f939de3be84e66e757adcdcb87908023
      readOnly: true
      maxLength: 32
    cache_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    bill-subs-api_current_period_start:
      type: string
      format: date-time
      description: When the current billing period started. May match initial_period_start if this is the first period.
      example: '2014-05-11T12:20:00Z'
      readOnly: true
    zaraz_zaraz-history-response:
      allOf:
      - $ref: '#/components/schemas/zaraz_api-response-common'
      - properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/zaraz_zaraz-config-row-base'
              - type: object
                example:
                  createdAt: '2023-02-23T05:05:55.155273Z'
                  description: Config with enabled ecommerce tracking
                  id: 12345
                  updatedAt: '2023-02-23T05:05:55.155273Z'
                  userId: 278d0d0g123cd8e49d45ea64f12faa37
                required:
                - description
                properties:
                  description:
                    type: string
                    description: Configuration description provided by the user who published this configuration
    api-shield_schema_upload_details_errors_critical:
      type: object
      properties:
        critical:
          type: array
          description: Diagnostic critical error events that occurred during processing.
          items:
            $ref: '#/components/schemas/api-shield_schema_upload_log_event'
        errors:
          type: array
          description: Diagnostic error events that occurred during processing.
          items:
            $ref: '#/components/schemas/api-shield_schema_upload_log_event'
    zones_image_resizing_value:
      type: string
      description: Whether the feature is enabled, disabled, or enabled in `open proxy` mode.
      enum:
      - 'on'
      - 'off'
      - open
      default: 'off'
    observatory_page-test-response-single:
      allOf:
      - $ref: '#/components/schemas/observatory_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/observatory_page_test'
    cache-purge_Tags:
      type: object
      properties:
        tags:
          type: array
          example:
          - some-tag
          - another-tag
          items:
            type: string
    tls-certificates-and-hostnames_created_at:
      type: string
      format: date-time
      description: This is the time the hostname was created.
      example: '2020-02-06T18:11:23.531995Z'
    legacy-jhs_paused:
      type: boolean
      description: When true, indicates that the WAF package is currently paused.
    access_authentication_method_rule:
      type: object
      title: Authentication method
      description: Enforce different MFA options
      required:
      - auth_method
      properties:
        auth_method:
          type: object
          required:
          - auth_method
          properties:
            auth_method:
              type: string
              description: The type of authentication method https://datatracker.ietf.org/doc/html/rfc8176.
              example: mfa
    email_dns_settings_response_collection:
      allOf:
      - $ref: '#/components/schemas/email_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/email_dns_record'
    waitingroom_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    secondary-dns_time:
      type: string
      description: The time for a specific event.
      example: '2019-10-24T17:09:42.883908+01:00'
    waitingroom_session_duration:
      type: integer
      description: Lifetime of a cookie (in minutes) set by Cloudflare for users who get access to the route. If a user is not seen by Cloudflare again in that time period, they will be treated as a new user that visits the route.
      default: 5
      minimum: 1
      maximum: 30
    waf-managed-rules_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    email_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    api-shield_characteristics:
      type: array
      uniqueItems: true
      maxItems: 10
      items:
        type: object
        required:
        - type
        - name
        properties:
          name:
            $ref: '#/components/schemas/api-shield_name'
          type:
            $ref: '#/components/schemas/api-shield_type'
    zones_ciphers_value:
      type: array
      description: Value of the zone setting.
      default: []
      example:
      - ECDHE-RSA-AES128-GCM-SHA256
      - AES128-SHA
      uniqueItems: true
      items:
        type: string
    waf-managed-rules_allowed_modes_deny_traditional:
      type: array
      description: The list of possible actions of the WAF rule when it is triggered.
      example:
      - default
      - disable
      - simulate
      - block
      - challenge
      readOnly: true
      items:
        $ref: '#/components/schemas/waf-managed-rules_mode_deny_traditional'
    dns-records_HTTPSRecord:
      allOf:
      - properties:
          content:
            type: string
            description: Formatted HTTPS content. See 'data' to set HTTPS properties.
            readOnly: true
          data:
            type: object
            description: Components of a HTTPS record.
            properties:
              priority:
                type: number
                description: priority.
                example: 1
                minimum: 0
                maximum: 65535
              target:
                type: string
                description: target.
                example: .
              value:
                type: string
                description: value.
                example: alpn="h3,h2" ipv4hint="127.0.0.1" ipv6hint="::1"
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - HTTPS
            example: HTTPS
      - $ref: '#/components/schemas/dns-records_base'
      title: HTTPS Record
      required:
      - type
      - name
      - data
    tls-certificates-and-hostnames_delete_advanced_certificate_pack_response_single:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - type: object
        properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
    custom-pages_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/custom-pages_messages'
        messages:
          $ref: '#/components/schemas/custom-pages_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    bill-subs-api_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/bill-subs-api_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/bill-subs-api_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    tls-certificates-and-hostnames_schemas-csr:
      type: string
      description: The Certificate Signing Request (CSR). Must be newline-encoded.
      example: --BEGIN CERTIFICATE REQUEST--\nMIICY....\n--END CERTIFICATE REQUEST--\n
    legacy-jhs_filter-delete-response-single:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - type: object
        required:
        - result
        properties:
          result:
            allOf:
            - $ref: '#/components/schemas/legacy-jhs_filter'
            - type: object
              required:
              - id
    api-shield_p50:
      type: integer
      description: The p50 quantile of requests (in period_seconds).
      readOnly: true
    dnssec_delete_dnssec_response_single:
      allOf:
      - $ref: '#/components/schemas/dnssec_api-response-single'
      - properties:
          result:
            type: string
            example: ''
    logpush_output_options:
      type: object
      description: The structured replacement for `logpull_options`. When including this field, the `logpull_option` field will be ignored.
      nullable: true
      properties:
        CVE-2021-4428:
          type: boolean
          description: If set to true, will cause all occurrences of `${` in the generated files to be replaced with `x{`.
          default: false
          nullable: true
        batch_prefix:
          type: string
          description: String to be prepended before each batch.
          default: ''
          nullable: true
        batch_suffix:
          type: string
          description: String to be appended after each batch.
          default: ''
          nullable: true
        field_delimiter:
          type: string
          description: String to join fields. This field be ignored when `record_template` is set.
          default: ','
          nullable: true
        field_names:
          type: array
          description: List of field names to be included in the Logpush output. For the moment, there is no option to add all fields at once, so you must specify all the fields names you are interested in.
          example:
          - ClientIP
          - EdgeStartTimestamp
          - RayID
          items:
            type: string
        output_type:
          type: string
          description: Specifies the output type, such as `ndjson` or `csv`. This sets default values for the rest of the settings, depending on the chosen output type. Some formatting rules, like string quoting, are different between output types.
          enum:
          - ndjson
          - csv
          default: ndjson
          example: ndjson
        record_delimiter:
          type: string
          description: String to be inserted in-between the records as separator.
          default: ''
          nullable: true
        record_prefix:
          type: string
          description: String to be prepended before each record.
          default: '{'
          nullable: true
        record_suffix:
          type: string
          description: String to be appended after each record.
          default: '}

            '
          nullable: true
        record_template:
          type: string
          description: String to use as template for each record instead of the default comma-separated list. All fields used in the template must be present in `field_names` as well, otherwise they will end up as null. Format as a Go `text/template` without any standard functions, like conditionals, loops, sub-templates, etc.
          default: ''
          nullable: true
        sample_rate:
          type: number
          format: float
          description: Floating number to specify sampling rate. Sampling is applied on top of filtering, and regardless of the current `sample_interval` of the data.
          default: 1
          nullable: true
          minimum: 0
          maximum: 1
        timestamp_format:
          type: string
          description: String to specify the format for timestamps, such as `unixnano`, `unix`, or `rfc3339`.
          enum:
          - unixnano
          - unix
          - rfc3339
          default: unixnano
    dns-records_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    tls-certificates-and-hostnames_schemas-certificate_authority:
      type: string
      description: Certificate Authority selected for the order.  For information on any certificate authority specific details or restrictions [see this page for more details.](https://developers.cloudflare.com/ssl/reference/certificate-authorities)
      enum:
      - google
      - lets_encrypt
      example: lets_encrypt
    email_settings:
      allOf:
      - $ref: '#/components/schemas/email_email_settings_properties'
      type: object
    tls-certificates-and-hostnames_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    logpush_frequency:
      type: string
      description: The frequency at which Cloudflare sends batches of logs to your destination. Setting frequency to high sends your logs in larger quantities of smaller files. Setting frequency to low sends logs in smaller quantities of larger files.
      enum:
      - high
      - low
      default: high
      example: high
      nullable: true
    workers_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    zones_browser_check:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - browser_check
            example: browser_check
          value:
            $ref: '#/components/schemas/zones_browser_check_value'
      title: Browser Check
      description: Browser Integrity Check is similar to Bad Behavior and looks for common HTTP headers abused most commonly by spammers and denies access to your page.  It will also challenge visitors that do not have a user agent or a non standard user agent (also commonly used by abuse bots, crawlers or visitors). (https://support.cloudflare.com/hc/en-us/articles/200170086).
    dns-records_NSRecord:
      allOf:
      - properties:
          content:
            description: A valid name server host name.
            example: ns1.example.com
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - NS
            example: NS
      - $ref: '#/components/schemas/dns-records_base'
      title: NS Record
      required:
      - type
      - name
      - content
    dweb-config_content_list_entries:
      type: array
      description: Content list entries.
      items:
        $ref: '#/components/schemas/dweb-config_content_list_entry'
    tls-certificates-and-hostnames_schemas-validation_method:
      type: string
      description: Validation method in use for a certificate pack order.
      enum:
      - http
      - cname
      - txt
      example: txt
    cache_response_single:
      allOf:
      - $ref: '#/components/schemas/cache_api-response-single'
      - type: object
        properties:
          result:
            type: object
    cache-purge_Flex:
      anyOf:
      - $ref: '#/components/schemas/cache-purge_Tags'
      - $ref: '#/components/schemas/cache-purge_Hosts'
      - $ref: '#/components/schemas/cache-purge_Prefixes'
    healthchecks_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    access_schemas-require:
      type: array
      description: Rules evaluated with an AND logical operator. To match the policy, a user must meet all of the Require rules.
      items:
        $ref: '#/components/schemas/access_rule'
    legacy-jhs_timeout:
      type: number
      description: 'The time in seconds during which Cloudflare will perform the mitigation action. Must be an integer value greater than or equal to the period.

        Notes: If "mode" is "challenge", "managed_challenge", or "js_challenge", Cloudflare will use the zone''s Challenge Passage time and you should not provide this value.'
      example: 86400
      minimum: 1
      maximum: 86400
    dns-records_priority:
      type: number
      description: Required for MX, SRV and URI records; unused by other record types. Records with lower priorities are preferred.
      example: 10
      minimum: 0
      maximum: 65535
    access_login_design:
      properties:
        background_color:
          type: string
          description: The background color on your login page.
          example: '#c5ed1b'
        footer_text:
          type: string
          description: The text at the bottom of your login page.
          example: This is an example description.
        header_text:
          type: string
          description: The text at the top of your login page.
          example: This is an example description.
        logo_path:
          type: string
          description: The URL of the logo on your login page.
          example: https://example.com/logo.png
        text_color:
          type: string
          description: The text color on your login page.
          example: '#c5ed1b'
    zones_server_side_exclude:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - server_side_exclude
            example: server_side_exclude
          value:
            $ref: '#/components/schemas/zones_server_side_exclude_value'
      title: Server Side Exclude
      description: 'If there is sensitive content on your website that you want visible to real visitors, but that you want to hide from suspicious visitors, all you have to do is wrap the content with Cloudflare SSE tags. Wrap any content that you want to be excluded from suspicious visitors in the following SSE tags: <!--sse--><!--/sse-->. For example: <!--sse-->  Bad visitors won''t see my phone number, 555-555-5555 <!--/sse-->. Note: SSE only will work with HTML. If you have HTML minification enabled, you won''t see the SSE tags in your HTML source when it''s served through Cloudflare. SSE will still function in this case, as Cloudflare''s HTML minification and SSE functionality occur on-the-fly as the resource moves through our network to the visitor''s computer. (https://support.cloudflare.com/hc/en-us/articles/200170036).'
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate_response_collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull'
    observatory_uuid:
      type: string
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      readOnly: true
      maxLength: 36
    workers_route-response-collection:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/workers_routes'
    access_allowed_origins:
      type: array
      description: Allowed origins.
      example:
      - https://example.com
      items: {}
    waf-managed-rules_base:
      properties:
        description:
          $ref: '#/components/schemas/waf-managed-rules_schemas-description'
        group:
          type: object
          description: The rule group to which the current WAF rule belongs.
          readOnly: true
          properties:
            id:
              $ref: '#/components/schemas/waf-managed-rules_components-schemas-identifier'
            name:
              $ref: '#/components/schemas/waf-managed-rules_name'
        id:
          $ref: '#/components/schemas/waf-managed-rules_rule_components-schemas-identifier'
        package_id:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
        priority:
          $ref: '#/components/schemas/waf-managed-rules_priority'
    data-zone-analytics-api_api-response-single:
      allOf:
      - $ref: '#/components/schemas/data-zone-analytics-api_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
              nullable: true
            - type: string
              nullable: true
      type: object
    rulesets_RulePosition:
      type: object
      title: Position
      description: An object configuring where the rule will be placed.
    zones_prefetch_preload:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - prefetch_preload
            example: prefetch_preload
          value:
            $ref: '#/components/schemas/zones_prefetch_preload_value'
      title: Prefetch preload
      description: Cloudflare will prefetch any URLs that are included in the response headers. This is limited to Enterprise Zones.
      default: 'off'
    bill-subs-api_zone_subscription_response_single:
      allOf:
      - $ref: '#/components/schemas/bill-subs-api_api-response-single'
      - type: object
        properties:
          result:
            type: object
    tls-certificates-and-hostnames_components-schemas-certificate_response_single:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificateObject'
    bot-management_sbfm_static_resource_protection:
      type: boolean
      description: 'Super Bot Fight Mode (SBFM) to enable static resource protection.

        Enable if static resources on your application need bot protection.

        Note: Static resource protection can also result in legitimate traffic being blocked.

        '
      example: true
    legacy-jhs_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/legacy-jhs_messages'
        messages:
          $ref: '#/components/schemas/legacy-jhs_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    dweb-config_status:
      type: string
      description: Status of the hostname's activation.
      enum:
      - active
      - pending
      - deleting
      - error
      example: active
      readOnly: true
    waitingroom_status:
      type: string
      enum:
      - event_prequeueing
      - not_queueing
      - queueing
      example: queueing
    observatory_availabilities:
      type: object
      properties:
        quota:
          type: object
          properties:
            plan:
              type: string
              description: Cloudflare plan.
              example: free
            quotasPerPlan:
              type: object
              description: The number of tests available per plan.
            remainingSchedules:
              type: number
              description: The number of remaining schedules available.
              example: 1
            remainingTests:
              type: number
              description: The number of remaining tests available.
              example: 30
            scheduleQuotasPerPlan:
              type: object
              description: The number of schedules available per plan.
        regions:
          type: array
          items:
            $ref: '#/components/schemas/observatory_labeled_region'
        regionsPerPlan: {}
    waitingroom_queueing_method:
      type: string
      description: 'Sets the queueing method used by the waiting room. Changing this parameter from the **default** queueing method is only available for the Waiting Room Advanced subscription. Regardless of the queueing method, if `queue_all` is enabled or an event is prequeueing, users in the waiting room will not be accepted to the origin. These users will always see a waiting room page that refreshes automatically. The valid queueing methods are:

        1. `fifo` **(default)**: First-In-First-Out queue where customers gain access in the order they arrived.

        2. `random`: Random queue where customers gain access randomly, regardless of arrival time.

        3. `passthrough`: Users will pass directly through the waiting room and into the origin website. As a result, any configured limits will not be respected while this is enabled. This method can be used as an alternative to disabling a waiting room (with `suspended`) so that analytics are still reported. This can be used if you wish to allow all traffic normally, but want to restrict traffic during a waiting room event, or vice versa.

        4. `reject`: Users will be immediately rejected from the waiting room. As a result, no users will reach the origin website while this is enabled. This can be used if you wish to reject all traffic while performing maintenance, block traffic during a specified period of time (an event), or block traffic while events are not occurring. Consider a waiting room used for vaccine distribution that only allows traffic during sign-up events, and otherwise blocks all traffic. For this case, the waiting room uses `reject`, and its events override this with `fifo`, `random`, or `passthrough`. When this queueing method is enabled and neither `queueAll` is enabled nor an event is prequeueing, the waiting room page **will not refresh automatically**.'
      enum:
      - fifo
      - random
      - passthrough
      - reject
      default: fifo
      example: fifo
    dns-records_LOCRecord:
      allOf:
      - properties:
          content:
            type: string
            description: Formatted LOC content. See 'data' to set LOC properties.
            example: IN LOC 37 46 46 N 122 23 35 W 0m 100m 0m 0m
            readOnly: true
          data:
            type: object
            description: Components of a LOC record.
            properties:
              altitude:
                type: number
                description: Altitude of location in meters.
                example: 0
                minimum: -100000
                maximum: 42849672.95
              lat_degrees:
                type: number
                description: Degrees of latitude.
                example: 37
                minimum: 0
                maximum: 90
              lat_direction:
                description: Latitude direction.
                enum:
                - N
                - S
                example: N
              lat_minutes:
                type: number
                description: Minutes of latitude.
                default: 0
                example: 46
                minimum: 0
                maximum: 59
              lat_seconds:
                type: number
                description: Seconds of latitude.
                default: 0
                example: 46
                minimum: 0
                maximum: 59.999
              long_degrees:
                type: number
                description: Degrees of longitude.
                example: 122
                minimum: 0
                maximum: 180
              long_direction:
                description: Longitude direction.
                enum:
                - E
                - W
                example: W
              long_minutes:
                type: number
                description: Minutes of longitude.
                default: 0
                example: 23
                minimum: 0
                maximum: 59
              long_seconds:
                type: number
                description: Seconds of longitude.
                default: 0
                example: 35
                minimum: 0
                maximum: 59.999
              precision_horz:
                type: number
                description: Horizontal precision of location.
                default: 0
                example: 0
                minimum: 0
                maximum: 90000000
              precision_vert:
                type: number
                description: Vertical precision of location.
                default: 0
                example: 0
                minimum: 0
                maximum: 90000000
              size:
                type: number
                description: Size of location in meters.
                default: 0
                example: 100
                minimum: 0
                maximum: 90000000
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - LOC
            example: LOC
      - $ref: '#/components/schemas/dns-records_base'
      title: LOC Record
      required:
      - type
      - name
      - data
    argo-analytics_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/argo-analytics_messages'
        messages:
          $ref: '#/components/schemas/argo-analytics_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    zones_brotli:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - brotli
            example: brotli
          value:
            $ref: '#/components/schemas/zones_brotli_value'
      title: Brotli Compression
      description: When the client requesting an asset supports the Brotli compression algorithm, Cloudflare will serve a Brotli compressed version of the asset.
    dnssec_flags:
      type: number
      description: Flag for DNSSEC record.
      example: 257
      nullable: true
      readOnly: true
    healthchecks_description:
      type: string
      description: A human-readable description of the health check.
      example: Health check for www.example.com
    zones_actions:
      type: array
      description: The set of actions to perform if the targets of this rule match the request. Actions can redirect to another URL or override settings, but not both.
      example:
      - id: browser_check
        value: 'on'
      items:
        oneOf:
        - $ref: '#/components/schemas/zones_route'
    api-shield_public_schema:
      type: object
      required:
      - schema_id
      - name
      - kind
      - created_at
      properties:
        created_at:
          $ref: '#/components/schemas/api-shield_timestamp'
        kind:
          $ref: '#/components/schemas/api-shield_kind'
        name:
          type: string
          description: Name of the schema
          example: petstore schema
        schema_id:
          $ref: '#/components/schemas/api-shield_uuid'
        source:
          type: string
          description: Source of the schema
          example: <schema file bytes>
        validation_enabled:
          $ref: '#/components/schemas/api-shield_validation_enabled'
    cache_value:
      type: string
      description: Enables Tiered Caching.
      enum:
      - 'on'
      - 'off'
      example: 'on'
    legacy-jhs_proxy_protocol:
      type: string
      description: Enables Proxy Protocol to the origin. Refer to [Enable Proxy protocol](https://developers.cloudflare.com/spectrum/getting-started/proxy-protocol/) for implementation details on PROXY Protocol V1, PROXY Protocol V2, and Simple Proxy Protocol.
      enum:
      - 'off'
      - v1
      - v2
      - simple
      default: 'off'
      example: 'off'
    data-zone-analytics-api_timeseries_by_colo:
      type: array
      description: Time deltas containing metadata about each bucket of time. The number of buckets (resolution) is determined by the amount of time between the since and until parameters.
      items:
        type: object
        properties:
          bandwidth:
            $ref: '#/components/schemas/data-zone-analytics-api_bandwidth_by_colo'
          requests:
            $ref: '#/components/schemas/data-zone-analytics-api_requests_by_colo'
          since:
            $ref: '#/components/schemas/data-zone-analytics-api_since'
          threats:
            $ref: '#/components/schemas/data-zone-analytics-api_threats'
          until:
            $ref: '#/components/schemas/data-zone-analytics-api_until'
    legacy-jhs_action_mode:
      type: string
      description: The default action performed by the rules in the WAF package.
      enum:
      - simulate
      - block
      - challenge
      default: challenge
    waitingroom_event_result:
      type: object
      properties:
        created_on:
          $ref: '#/components/schemas/waitingroom_timestamp'
        custom_page_html:
          $ref: '#/components/schemas/waitingroom_event_custom_page_html'
        description:
          $ref: '#/components/schemas/waitingroom_event_description'
        disable_session_renewal:
          $ref: '#/components/schemas/waitingroom_event_disable_session_renewal'
        event_end_time:
          $ref: '#/components/schemas/waitingroom_event_end_time'
        event_start_time:
          $ref: '#/components/schemas/waitingroom_event_start_time'
        id:
          $ref: '#/components/schemas/waitingroom_event_id'
        modified_on:
          $ref: '#/components/schemas/waitingroom_timestamp'
        name:
          $ref: '#/components/schemas/waitingroom_event_name'
        new_users_per_minute:
          $ref: '#/components/schemas/waitingroom_event_new_users_per_minute'
        prequeue_start_time:
          $ref: '#/components/schemas/waitingroom_event_prequeue_start_time'
        queueing_method:
          $ref: '#/components/schemas/waitingroom_event_queueing_method'
        session_duration:
          $ref: '#/components/schemas/waitingroom_event_session_duration'
        shuffle_at_event_start:
          $ref: '#/components/schemas/waitingroom_event_shuffle_at_event_start'
        suspended:
          $ref: '#/components/schemas/waitingroom_event_suspended'
        total_active_users:
          $ref: '#/components/schemas/waitingroom_event_total_active_users'
    access_schemas-aud:
      type: string
      description: Audience tag.
      example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893
      readOnly: true
      maxLength: 64
    bill-subs-api_currency:
      type: string
      description: The monetary unit in which pricing information is displayed.
      example: USD
      readOnly: true
    access_exclude:
      type: array
      description: Rules evaluated with a NOT logical operator. To match a policy, a user cannot meet any of the Exclude rules.
      items:
        $ref: '#/components/schemas/access_rule'
    zone-activation_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    dns-records_proxied:
      type: boolean
      description: Whether the record is receiving the performance and security benefits of Cloudflare.
      example: false
    secondary-dns_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/secondary-dns_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/secondary-dns_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    zones_websockets:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - websockets
            example: websockets
          value:
            $ref: '#/components/schemas/zones_websockets_value'
      title: WebSockets
      description: WebSockets are open connections sustained between the client and the origin server. Inside a WebSockets connection, the client and the origin can pass data back and forth without having to reestablish sessions. This makes exchanging data within a WebSockets connection fast. WebSockets are often used for real-time applications such as live chat and gaming. For more information refer to [Can I use Cloudflare with Websockets](https://support.cloudflare.com/hc/en-us/articles/200169466-Can-I-use-Cloudflare-with-WebSockets-).
    dns-records_dns_response_collection:
      allOf:
      - $ref: '#/components/schemas/dns-records_api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/dns-records_dns-record'
    data-zone-analytics-api_end:
      anyOf:
      - type: string
      - type: integer
      description: Sets the (exclusive) end of the requested time frame. This can be a unix timestamp (in seconds or nanoseconds), or an absolute timestamp that conforms to RFC 3339. `end` must be at least five minutes earlier than now and must be later than `start`. Difference between `start` and `end` must be not greater than one hour.
      example: '2018-05-20T10:01:00Z'
    snippets-api_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    waf-managed-rules_rule_group_response_single:
      allOf:
      - $ref: '#/components/schemas/waf-managed-rules_api-response-single'
      - properties:
          result:
            type: object
    access_auth_domain:
      type: string
      description: The unique subdomain assigned to your Zero Trust organization.
      example: test.cloudflareaccess.com
    logpush_ownership_challenge:
      type: string
      description: Ownership challenge token to prove destination ownership.
      example: '00000000000000000000'
      maxLength: 4096
      pattern: ^[a-zA-Z0-9/\+\.\-_]*$
    zone-activation_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/zone-activation_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/zone-activation_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    zones_response_buffering:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - response_buffering
            example: response_buffering
          value:
            $ref: '#/components/schemas/zones_response_buffering_value'
      title: Response Buffering
      description: Enables or disables buffering of responses from the proxied server. Cloudflare may buffer the whole payload to deliver it at once to the client versus allowing it to be delivered in chunks. By default, the proxied server streams directly and is not buffered by Cloudflare. This is limited to Enterprise Zones.
      default: 'off'
    observatory_result_info:
      type: object
      properties:
        count:
          type: integer
          example: 5
        page:
          type: integer
          example: 1
        per_page:
          type: integer
          example: 5
        total_count:
          type: integer
          example: 3
    access_gsuite_group_rule:
      type: object
      title: Google Workspace group
      description: 'Matches a group in Google Workspace.

        Requires a Google Workspace identity provider.'
      required:
      - gsuite
      properties:
        gsuite:
          type: object
          required:
          - email
          - connection_id
          properties:
            connection_id:
              type: string
              description: The ID of your Google Workspace identity provider.
              example: ea85612a-29c8-46c2-bacb-669d65136971
            email:
              type: string
              description: The email of the Google Workspace group.
              example: devs@cloudflare.com
    healthchecks_response_collection:
      allOf:
      - $ref: '#/components/schemas/healthchecks_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/healthchecks_healthchecks'
    legacy-jhs_response_single_origin_dns:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - properties:
          result:
            properties:
              argo_smart_routing:
                $ref: '#/components/schemas/legacy-jhs_argo_smart_routing'
              created_on:
                $ref: '#/components/schemas/legacy-jhs_created'
              dns:
                $ref: '#/components/schemas/legacy-jhs_dns'
              edge_ips:
                $ref: '#/components/schemas/legacy-jhs_edge_ips'
              id:
                $ref: '#/components/schemas/legacy-jhs_app_id'
              ip_firewall:
                $ref: '#/components/schemas/legacy-jhs_ip_firewall'
              modified_on:
                $ref: '#/components/schemas/legacy-jhs_modified'
              origin_dns:
                $ref: '#/components/schemas/legacy-jhs_origin_dns'
              origin_port:
                $ref: '#/components/schemas/legacy-jhs_origin_port'
              protocol:
                $ref: '#/components/schemas/legacy-jhs_protocol'
              proxy_protocol:
                $ref: '#/components/schemas/legacy-jhs_proxy_protocol'
              tls:
                $ref: '#/components/schemas/legacy-jhs_tls'
              traffic_type:
                $ref: '#/components/schemas/legacy-jhs_traffic_type'
    api-shield_host:
      type: string
      format: hostname
      description: RFC3986-compliant host.
      example: www.example.com
      maxLength: 255
    bill-subs-api_rate-plan_components-schemas-identifier:
      type: string
      description: Plan identifier tag.
      example: free
      readOnly: true
    tls-certificates-and-hostnames_value:
      oneOf:
      - type: number
      - type: string
      - type: array
        items:
          type: string
      description: The tls setting value.
      example:
      - ECDHE-RSA-AES128-GCM-SHA256
      - AES128-GCM-SHA256
    observatory_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/observatory_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/observatory_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    dnssec_digest_type:
      type: string
      description: Coded type for digest algorithm.
      example: '2'
      nullable: true
      readOnly: true
    zones_origin_error_page_pass_thru_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    tls-certificates-and-hostnames_components-schemas-uploaded_on:
      type: string
      format: date-time
      description: The time when the certificate was uploaded.
      example: '2019-10-28T18:11:23.37411Z'
    tls-certificates-and-hostnames_type:
      type: string
      description: The type 'legacy_custom' enables support for legacy clients which do not include SNI in the TLS handshake.
      enum:
      - legacy_custom
      - sni_custom
      default: legacy_custom
      example: sni_custom
    legacy-jhs_header_op:
      type: string
      description: 'The operator used when matching: `eq` means "equal" and `ne` means "not equal".'
      enum:
      - eq
      - ne
      example: ne
    access_schemas-saas_props:
      type: object
      title: SaaS Application
      properties:
        allowed_idps:
          $ref: '#/components/schemas/access_allowed_idps'
        app_launcher_visible:
          $ref: '#/components/schemas/access_app_launcher_visible'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity'
        logo_url:
          $ref: '#/components/schemas/access_logo_url'
        name:
          $ref: '#/components/schemas/access_apps_components-schemas-name'
        saas_app:
          oneOf:
          - $ref: '#/components/schemas/access_schemas-saml_saas_app'
          - $ref: '#/components/schemas/access_oidc_saas_app'
          type: object
        type:
          type: string
          description: The application type.
          example: saas
    zones_tls_client_auth_value:
      type: string
      description: value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'on'
    zaraz_zaraz-config-history-response:
      allOf:
      - $ref: '#/components/schemas/zaraz_api-response-common'
      - properties:
          result:
            type: object
            description: Object where keys are numericc onfiguration IDs
            example:
              '12345':
                config:
                  consent:
                    cookieName: zaraz-consent
                    customIntroDisclaimerDismissed: true
                    enabled: false
                  dataLayer: true
                  debugKey: my-debug-key
                  settings:
                    autoInjectScript: true
                  tools:
                    aJvt:
                      component: facebook-pixel
                      defaultFields:
                        testKey: TEST123456
                      enabled: true
                      name: Facebook Pixel
                      neoEvents:
                      - actionType: pageview
                        blockingTriggers: []
                        data:
                          __zaraz_setting_name: Page view
                          ev: PageView
                        firingTriggers:
                        - Pageview
                      permissions:
                      - access_client_kv
                      settings:
                        accessToken: ABcdEFg
                        ecommerce: true
                        property: '12345'
                      type: component
                  triggers:
                    ktBn:
                      Pageview:
                        clientRules: []
                        description: All page loads
                        excludeRules: []
                        loadRules:
                        - match: '{{ client.__zarazTrack }}'
                          op: EQUALS
                          value: Pageview
                        name: Pageview
                        system: pageload
                  variables:
                    Autd:
                      name: ip
                      type: string
                      value: '{{ system.device.ip }}'
                  zarazVersion: 43
                createdAt: '2023-02-23T05:05:55.155273Z'
                id: 12345
                updatedAt: '2023-02-23T05:05:55.155273Z'
                userId: 278d0d0g123cd8e49d45ea64f12faa37
              '23456': null
    legacy-jhs_products:
      type: array
      items:
        type: string
        description: A list of products to bypass for a request when using the `bypass` action.
        enum:
        - zoneLockdown
        - uaBlock
        - bic
        - hot
        - securityLevel
        - rateLimit
        - waf
        example: waf
    load-balancing_session_affinity_attributes:
      type: object
      description: Configures attributes for session affinity.
      properties:
        drain_duration:
          type: number
          description: Configures the drain duration in seconds. This field is only used when session affinity is enabled on the load balancer.
          example: 100
        headers:
          type: array
          description: 'Configures the names of HTTP headers to base session affinity on when header `session_affinity` is enabled. At least one HTTP header name must be provided. To specify the exact cookies to be used, include an item in the following format: `"cookie:<cookie-name-1>,<cookie-name-2>"` (example) where everything after the colon is a comma-separated list of cookie names. Providing only `"cookie"` will result in all cookies being used. The default max number of HTTP header names that can be provided depends on your plan: 5 for Enterprise, 1 for all other plans.'
          default: none
          uniqueItems: true
          items:
            type: string
            description: An HTTP header name.
            minLength: 1
            maxLength: 100
            pattern: ^[a-zA-Z0-9_-]+$
        require_all_headers:
          type: boolean
          description: 'When header `session_affinity` is enabled, this option can be used to specify how HTTP headers on load balancing requests will be used. The supported values are:

            - `"true"`: Load balancing requests must contain *all* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren''t created.

            - `"false"`: Load balancing requests must contain *at least one* of the HTTP headers specified by the `headers` session affinity attribute, otherwise sessions aren''t created.'
          default: false
        samesite:
          type: string
          description: 'Configures the SameSite attribute on session affinity cookie. Value "Auto" will be translated to "Lax" or "None" depending if Always Use HTTPS is enabled. Note: when using value "None", the secure attribute can not be set to "Never".'
          enum:
          - Auto
          - Lax
          - None
          - Strict
          default: Auto
          example: Auto
        secure:
          type: string
          description: Configures the Secure attribute on session affinity cookie. Value "Always" indicates the Secure attribute will be set in the Set-Cookie header, "Never" indicates the Secure attribute will not be set, and "Auto" will set the Secure attribute depending if Always Use HTTPS is enabled.
          enum:
          - Auto
          - Always
          - Never
          default: Auto
          example: Auto
        zero_downtime_failover:
          type: string
          description: 'Configures the zero-downtime failover between origins within a pool when session affinity is enabled. This feature is currently incompatible with Argo, Tiered Cache, and Bandwidth Alliance. The supported values are:

            - `"none"`: No failover takes place for sessions pinned to the origin (default).

            - `"temporary"`: Traffic will be sent to another other healthy origin until the originally pinned origin is available; note that this can potentially result in heavy origin flapping.

            - `"sticky"`: The session affinity cookie is updated and subsequent requests are sent to the new origin. Note: Zero-downtime failover with sticky sessions is currently not supported for session affinity by header.'
          enum:
          - none
          - temporary
          - sticky
          default: none
          example: sticky
    waitingroom_event_details_queueing_method:
      type: string
      example: random
    legacy-jhs_components-schemas-description:
      type: string
      description: An informative summary of the rate limit. This value is sanitized and any tags will be removed.
      example: Prevent multiple login failures to mitigate brute force attacks
      maxLength: 1024
    access_schemas-auto_redirect_to_identity:
      type: boolean
      description: When set to `true`, users skip the identity provider selection step during login. You must specify only one identity provider in allowed_idps.
      default: false
    access_email_list_rule:
      type: object
      title: Email list
      description: Matches an email address from a list.
      required:
      - email_list
      properties:
        email_list:
          type: object
          required:
          - id
          properties:
            id:
              type: string
              description: The ID of a previously created email list.
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
    access_service-tokens:
      type: object
      properties:
        client_id:
          $ref: '#/components/schemas/access_client_id'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        duration:
          $ref: '#/components/schemas/access_duration'
        id:
          description: The ID of the service token.
        name:
          $ref: '#/components/schemas/access_service-tokens_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
    zones_status:
      type: string
      description: The status of the Page Rule.
      enum:
      - active
      - disabled
      default: disabled
      example: active
    access_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/access_result_info'
      type: object
    api-shield_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    waitingroom_event_start_time:
      type: string
      description: An ISO 8601 timestamp that marks the start of the event. At this time, queued users will be processed with the event's configuration. The start time must be at least one minute before `event_end_time`.
      example: '2021-09-28T15:30:00.000Z'
    observatory_device_type:
      type: string
      description: The type of device.
      enum:
      - DESKTOP
      - MOBILE
      example: DESKTOP
    tls-certificates-and-hostnames_hostname_post:
      type: string
      description: The custom hostname that will point to your hostname via CNAME.
      example: app.example.com
      maxLength: 255
    zones_h2_prioritization:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - h2_prioritization
            example: h2_prioritization
          value:
            $ref: '#/components/schemas/zones_h2_prioritization_value'
      title: HTTP/2 Edge Prioritization
      description: HTTP/2 Edge Prioritization optimises the delivery of resources served through HTTP/2 to improve page load performance. It also supports fine control of content delivery when used in conjunction with Workers.
    logpush_id:
      type: integer
      description: Unique id of the job.
      minimum: 1
    email_rules:
      allOf:
      - $ref: '#/components/schemas/email_rule_properties'
      type: object
    waitingroom_rule_enabled:
      type: boolean
      description: When set to true, the rule is enabled.
      default: true
      example: true
    waitingroom_event_total_active_users:
      type: integer
      description: If set, the event will override the waiting room's `total_active_users` property while it is active. If null, the event will inherit it. This can only be set if the event's `new_users_per_minute` property is also set.
      nullable: true
      minimum: 200
      maximum: 2147483647
    tls-certificates-and-hostnames_hostname:
      type: string
      description: The custom hostname that will point to your hostname via CNAME.
      example: app.example.com
      readOnly: true
      maxLength: 255
    page-shield_pageshield-policy-description:
      type: string
      description: A description for the policy
      example: Checkout page CSP policy
    dns-records_api-response-single:
      allOf:
      - $ref: '#/components/schemas/dns-records_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    observatory_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    zones_early_hints:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - early_hints
            example: early_hints
          value:
            $ref: '#/components/schemas/zones_early_hints_value'
      title: Early Hints
      description: When enabled, Cloudflare will attempt to speed up overall page loads by serving `103` responses with `Link` headers from the final response. Refer to [Early Hints](https://developers.cloudflare.com/cache/about/early-hints) for more information.
    tls-certificates-and-hostnames_custom_hostname_response_single:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            allOf:
            - $ref: '#/components/schemas/tls-certificates-and-hostnames_custom-hostname'
            type: object
    tls-certificates-and-hostnames_certificate_response_collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_custom-certificate'
    cache_base:
      required:
      - id
      - modified_on
      properties:
        id:
          type: string
          description: Identifier of the zone setting.
        modified_on:
          type: string
          format: date-time
          description: last time this setting was modified.
          example: '2014-01-01T05:20:00.12345Z'
          nullable: true
          readOnly: true
    zones_advanced_ddos_value:
      type: string
      description: 'Value of the zone setting.

        Notes: Defaults to on for Business+ plans'
      enum:
      - 'on'
      - 'off'
      default: 'off'
    waf-managed-rules_api-response-single:
      allOf:
      - $ref: '#/components/schemas/waf-managed-rules_api-response-common'
      - properties:
          result:
            oneOf:
            - type: object
              nullable: true
            - type: string
              nullable: true
      type: object
    waitingroom_api-response-single:
      allOf:
      - $ref: '#/components/schemas/waitingroom_api-response-common'
      - properties:
          result:
            oneOf:
            - type: object
            - type: string
      type: object
    zones_opportunistic_onion:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - opportunistic_onion
            example: opportunistic_onion
          value:
            $ref: '#/components/schemas/zones_opportunistic_onion_value'
      title: Zone Enable Onion Routing
      description: Add an Alt-Svc header to all legitimate requests from Tor, allowing the connection to use our onion services instead of exit nodes.
      default: 'off'
    zones_api-response-single-id:
      allOf:
      - $ref: '#/components/schemas/zones_api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            required:
            - id
            properties:
              id:
                $ref: '#/components/schemas/zones_identifier'
      type: object
    legacy-jhs_filter-rule-response:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_filter-rule-base'
      - properties:
          filter:
            oneOf:
            - $ref: '#/components/schemas/legacy-jhs_filter'
            - $ref: '#/components/schemas/legacy-jhs_deleted-filter'
      type: object
    zones_min_tls_version:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - min_tls_version
            example: min_tls_version
          value:
            $ref: '#/components/schemas/zones_min_tls_version_value'
      title: Zone Minimum TLS Version value
      description: Only accepts HTTPS requests that use at least the TLS protocol version specified. For example, if TLS 1.1 is selected, TLS 1.0 connections will be rejected, while 1.1, 1.2, and 1.3 (if enabled) will be permitted.
      default: '1.0'
    bot-management_sbfm_likely_automated:
      type: string
      description: Super Bot Fight Mode (SBFM) action to take on likely automated requests.
      enum:
      - allow
      - block
      - managed_challenge
      example: allow
    zones_security_level:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - security_level
            example: security_level
          value:
            $ref: '#/components/schemas/zones_security_level_value'
      title: Security Level
      description: Choose the appropriate security profile for your website, which will automatically adjust each of the security settings. If you choose to customize an individual security setting, the profile will become Custom. (https://support.cloudflare.com/hc/en-us/articles/200170056).
    access_schemas-okta:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            allOf:
            - $ref: '#/components/schemas/access_generic-oauth-config'
            - type: object
              properties:
                okta_account:
                  type: string
                  description: Your okta account url
                  example: https://dev-abc123.oktapreview.com
      type: object
      title: Okta
    secondary-dns_single_response_outgoing:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-single'
      - properties:
          result:
            type: object
            properties:
              checked_time:
                $ref: '#/components/schemas/secondary-dns_time'
              created_time:
                $ref: '#/components/schemas/secondary-dns_time'
              id:
                $ref: '#/components/schemas/secondary-dns_identifier'
              last_transferred_time:
                $ref: '#/components/schemas/secondary-dns_time'
              name:
                $ref: '#/components/schemas/secondary-dns_name'
              peers:
                $ref: '#/components/schemas/secondary-dns_peers'
              soa_serial:
                $ref: '#/components/schemas/secondary-dns_soa_serial'
    page-shield_pageshield-policy-enabled:
      type: boolean
      description: Whether the policy is enabled
      example: true
    rulesets_RuleCategory:
      type: string
      title: Category
      description: A category of the rule.
      example: directory-traversal
      minLength: 1
    legacy-jhs_country_configuration:
      title: A country configuration.
      properties:
        target:
          description: The configuration target. You must set the target to `country` when specifying a country code in the rule.
          enum:
          - country
          example: country
        value:
          type: string
          description: 'The two-letter ISO-3166-1 alpha-2 code to match. For more information, refer to [IP Access rules: Parameters](https://developers.cloudflare.com/waf/tools/ip-access-rules/parameters/#country).'
          example: US
    waitingroom_event_details_total_active_users:
      type: integer
    zones_name:
      type: string
      description: The domain name
      example: example.com
      maxLength: 253
      pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$
    cache-purge_Files:
      type: object
      properties:
        files:
          type: array
          items:
            anyOf:
            - $ref: '#/components/schemas/cache-purge_File'
            - $ref: '#/components/schemas/cache-purge_UrlAndHeaders'
    observatory_availabilities-response:
      allOf:
      - $ref: '#/components/schemas/observatory_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/observatory_availabilities'
    rulesets_CreateOrUpdateRuleRequest:
      allOf:
      - $ref: '#/components/schemas/rulesets_RuleRequest'
      - properties:
          position:
            oneOf:
            - allOf:
              - $ref: '#/components/schemas/rulesets_RulePosition'
              - title: Before position
                properties:
                  before:
                    type: string
                    title: Before
                    description: The ID of another rule to place the rule before. An empty value causes the rule to be placed at the top.
                    example: da5e8e506c8e7877fe06cdf4c41add54
                    pattern: ^(?:[0-9a-f]{32})?$
            - allOf:
              - $ref: '#/components/schemas/rulesets_RulePosition'
              - title: After position
                properties:
                  after:
                    type: string
                    title: After
                    description: The ID of another rule to place the rule after. An empty value causes the rule to be placed at the bottom.
                    example: 5bccdbb2a5142cd25cad8591255bd209
                    pattern: ^(?:[0-9a-f]{32})?$
            - allOf:
              - $ref: '#/components/schemas/rulesets_RulePosition'
              - title: Index position
                properties:
                  index:
                    type: number
                    title: Index
                    description: An index at which to place the rule, where index 1 is the first rule.
                    example: 1
                    minimum: 1
    email_email_setting_skip-wizard:
      type: boolean
      description: Flag to check if the user skipped the configuration wizard.
      enum:
      - true
      - false
      default: true
      example: true
    legacy-jhs_schemas-filters:
      type: object
      properties:
        configuration.target:
          type: string
          description: The target to search in existing rules.
          enum:
          - ip
          - ip_range
          - asn
          - country
          example: ip
        configuration.value:
          type: string
          description: 'The target value to search for in existing rules: an IP address, an IP address range, or a country code, depending on the provided `configuration.target`.

            Notes: You can search for a single IPv4 address, an IP address range with a subnet of ''/16'' or ''/24'', or a two-letter ISO-3166-1 alpha-2 country code.'
          example: 198.51.100.4
        match:
          type: string
          description: When set to `all`, all the search requirements must match. When set to `any`, only one of the search requirements has to match.
          enum:
          - any
          - all
          default: all
        mode:
          $ref: '#/components/schemas/legacy-jhs_schemas-mode'
        notes:
          type: string
          description: 'The string to search for in the notes of existing IP Access rules.

            Notes: For example, the string ''attack'' would match IP Access rules with notes ''Attack 26/02'' and ''Attack 27/02''. The search is case insensitive.'
          example: my note
    zones_min_tls_version_value:
      type: string
      description: Value of the zone setting.
      enum:
      - '1.0'
      - '1.1'
      - '1.2'
      - '1.3'
      default: '1.0'
    logpush_destination_exists_response:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            properties:
              exists:
                type: boolean
                example: false
    zaraz_zaraz-workflow-response:
      allOf:
      - $ref: '#/components/schemas/zaraz_api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/zaraz_zaraz-workflow'
    legacy-jhs_filters_components-schemas-paused:
      type: boolean
      description: When true, indicates that the filter is currently paused.
      example: false
    dweb-config_content_list_entry_collection_response:
      allOf:
      - $ref: '#/components/schemas/dweb-config_api-response-collection'
      - properties:
          result:
            type: object
            properties:
              entries:
                $ref: '#/components/schemas/dweb-config_content_list_entries'
    dweb-config_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/dweb-config_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/dweb-config_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    dns-records_URIRecord:
      allOf:
      - properties:
          content:
            type: string
            description: Formatted URI content. See 'data' to set URI properties.
            readOnly: true
          data:
            type: object
            description: Components of a URI record.
            properties:
              content:
                type: string
                description: The record content.
                example: http://example.com/example.html
              weight:
                type: number
                description: The record weight.
                example: 20
                minimum: 0
                maximum: 65535
          name:
            $ref: '#/components/schemas/dns-records_name'
          priority:
            $ref: '#/components/schemas/dns-records_priority'
          type:
            type: string
            description: Record type.
            enum:
            - URI
            example: URI
      - $ref: '#/components/schemas/dns-records_base'
      title: URI Record
      required:
      - type
      - name
      - data
      - priority
    healthchecks_check_regions:
      type: array
      description: A list of regions from which to run health checks. Null means Cloudflare will pick a default region.
      example:
      - WEU
      - ENAM
      nullable: true
      items:
        type: string
        description: 'WNAM: Western North America, ENAM: Eastern North America, WEU: Western Europe, EEU: Eastern Europe, NSAM: Northern South America, SSAM: Southern South America, OC: Oceania, ME: Middle East, NAF: North Africa, SAF: South Africa, IN: India, SEAS: South East Asia, NEAS: North East Asia, ALL_REGIONS: all regions (BUSINESS and ENTERPRISE customers only).'
        enum:
        - WNAM
        - ENAM
        - WEU
        - EEU
        - NSAM
        - SSAM
        - OC
        - ME
        - NAF
        - SAF
        - IN
        - SEAS
        - NEAS
        - ALL_REGIONS
    legacy-jhs_sensitivity:
      type: string
      description: The sensitivity of the WAF package.
      enum:
      - high
      - medium
      - low
      - 'off'
      default: high
    waf-managed-rules_rule_response_single:
      allOf:
      - $ref: '#/components/schemas/waf-managed-rules_api-response-single'
      - properties:
          result:
            type: object
    page-shield_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    access_schemas-pingone:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            allOf:
            - $ref: '#/components/schemas/access_generic-oauth-config'
            - type: object
              properties:
                ping_env_id:
                  type: string
                  description: Your PingOne environment identifier
                  example: 342b5660-0c32-4936-a5a4-ce21fae57b0a
      type: object
      title: PingOne
    legacy-jhs_lockdowns_components-schemas-description:
      type: string
      description: An informative summary of the rule.
      example: Restrict access to these endpoints to requests from a known IP address
      maxLength: 1024
    waitingroom_status_response:
      allOf:
      - $ref: '#/components/schemas/waitingroom_api-response-single'
      - properties:
          result:
            type: object
            properties:
              estimated_queued_users:
                $ref: '#/components/schemas/waitingroom_estimated_queued_users'
              estimated_total_active_users:
                $ref: '#/components/schemas/waitingroom_estimated_total_active_users'
              event_id:
                $ref: '#/components/schemas/waitingroom_status_event_id'
              max_estimated_time_minutes:
                $ref: '#/components/schemas/waitingroom_max_estimated_time_minutes'
              status:
                $ref: '#/components/schemas/waitingroom_status'
    tls-certificates-and-hostnames_components-schemas-certificate_response_collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull'
    workers_binding_name:
      type: string
      description: A JavaScript variable name for the binding.
      example: myBinding
      readOnly: true
    waitingroom_queueing_status_code:
      type: integer
      description: HTTP status code returned to a user while in the queue.
      enum:
      - 200
      - 202
      - 429
      default: 200
      example: 202
    waitingroom_rule_version:
      type: string
      description: The version of the rule.
      example: '1'
    zones_page-rule:
      type: object
      required:
      - id
      - targets
      - actions
      - priority
      - status
      - modified_on
      - created_on
      properties:
        actions:
          $ref: '#/components/schemas/zones_actions'
        created_on:
          $ref: '#/components/schemas/zones_created_on'
        id:
          $ref: '#/components/schemas/zones_schemas-identifier'
        modified_on:
          $ref: '#/components/schemas/zones_schemas-modified_on'
        priority:
          $ref: '#/components/schemas/zones_priority'
        status:
          $ref: '#/components/schemas/zones_status'
        targets:
          $ref: '#/components/schemas/zones_targets'
    tls-certificates-and-hostnames_custom_hostname_response_collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_custom-hostname'
    logpush_api-response-single:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    access_http_only_cookie_attribute:
      type: boolean
      description: Enables the HttpOnly cookie attribute, which increases security against XSS attacks.
      default: true
      example: true
    dns-records_ttl:
      anyOf:
      - type: number
        example: 3600
        minimum: 30
        maximum: 86400
      - type: number
        enum:
        - 1
      type: number
      description: Time To Live (TTL) of the DNS record in seconds. Setting to 1 means 'automatic'. Value must be between 60 and 86400, with the minimum reduced to 30 for Enterprise zones.
      default: 1
      example: 3600
    data-zone-analytics-api_since:
      anyOf:
      - type: string
      - type: integer
      description: 'The (inclusive) beginning of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. At this point in time, it cannot exceed a time in the past greater than one year.


        Ranges that the Cloudflare web application provides will provide the following period length for each point:

        - Last 60 minutes (from -59 to -1): 1 minute resolution

        - Last 7 hours (from -419 to -60): 15 minutes resolution

        - Last 15 hours (from -899 to -420): 30 minutes resolution

        - Last 72 hours (from -4320 to -900): 1 hour resolution

        - Older than 3 days (-525600 to -4320): 1 day resolution.'
      default: -10080
      example: '2015-01-01T12:23:00Z'
    dns-records_comment:
      type: string
      description: Comments or notes about the DNS record. This field has no effect on DNS responses.
      example: Domain verification record
    dns-custom-nameservers_schemas-empty_response:
      allOf:
      - $ref: '#/components/schemas/dns-custom-nameservers_api-response-collection'
      - type: object
        properties:
          result:
            type: array
            maxItems: 0
            items: {}
    legacy-jhs_traffic_type:
      type: string
      description: Determines how data travels from the edge to your origin. When set to "direct", Spectrum will send traffic directly to your origin, and the application's type is derived from the `protocol`. When set to "http" or "https", Spectrum will apply Cloudflare's HTTP/HTTPS features as it sends traffic to your origin, and the application type matches this property exactly.
      enum:
      - direct
      - http
      - https
      default: direct
      example: direct
    access_is_ui_read_only:
      type: boolean
      description: Lock all settings as Read-Only in the Dashboard, regardless of user permission. Updates may only be made via the API or Terraform for this account when enabled.
      example: 'false'
    access_saml_group_rule:
      type: object
      title: SAML group
      description: 'Matches a SAML group.

        Requires a SAML identity provider.'
      required:
      - saml
      properties:
        saml:
          type: object
          required:
          - attribute_name
          - attribute_value
          properties:
            attribute_name:
              type: string
              description: The name of the SAML attribute.
              example: group
            attribute_value:
              type: string
              description: The SAML attribute value to look for.
              example: devs@cloudflare.com
    tls-certificates-and-hostnames_verification:
      type: object
      required:
      - certificate_status
      properties:
        brand_check:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_brand_check'
        cert_pack_uuid:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_cert_pack_uuid'
        certificate_status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_status'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-signature'
        validation_method:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-validation_method'
        verification_info:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_verification_info'
        verification_status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_verification_status'
        verification_type:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_verification_type'
    data-zone-analytics-api_until:
      anyOf:
      - type: string
      - type: integer
      description: The (exclusive) end of the requested time frame. This value can be a negative integer representing the number of minutes in the past relative to time the request is made, or can be an absolute timestamp that conforms to RFC 3339. If omitted, the time of the request is used.
      default: 0
      example: '2015-01-02T12:23:00Z'
    zones_image_resizing:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - image_resizing
            example: image_resizing
          value:
            $ref: '#/components/schemas/zones_image_resizing_value'
      title: Image Resizing
      description: Image Resizing provides on-demand resizing, conversion and optimisation for images served through Cloudflare's network. Refer to the [Image Resizing documentation](https://developers.cloudflare.com/images/) for more information.
    bill-subs-api_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    legacy-jhs_package_response_single:
      oneOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - properties:
          result:
            type: object
    legacy-jhs_delete_filter_if_unused:
      type: boolean
      description: When true, indicates that Cloudflare should also delete the associated filter if there are no other firewall rules referencing the filter.
    observatory_schedule:
      type: object
      description: The test schedule.
      properties:
        frequency:
          $ref: '#/components/schemas/observatory_schedule_frequency'
        region:
          $ref: '#/components/schemas/observatory_region'
        url:
          $ref: '#/components/schemas/observatory_url'
    bill-subs-api_rate-plan:
      type: object
      properties:
        components:
          $ref: '#/components/schemas/bill-subs-api_schemas-component_values'
        currency:
          $ref: '#/components/schemas/bill-subs-api_currency'
        duration:
          $ref: '#/components/schemas/bill-subs-api_duration'
        frequency:
          $ref: '#/components/schemas/bill-subs-api_schemas-frequency'
        id:
          $ref: '#/components/schemas/bill-subs-api_rate-plan_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/bill-subs-api_schemas-name'
    load-balancing_default_pools:
      type: array
      description: A list of pool IDs ordered by their failover priority. Pools defined here are used by default, or when region_pools are not configured for a given region.
      example:
      - 17b5962d775c646f3f9725cbc7a53df4
      - 9290f38c5d07c2e2f4df57b1f61d4196
      - 00920f38ce07c2e2f4df50b1f61d4194
      items:
        type: string
        description: A pool ID.
    access_ca_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/access_ca'
    healthchecks_timeout:
      type: integer
      description: The timeout (in seconds) before marking the health check as failed.
      default: 5
    zones_cname_flattening:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: How to flatten the cname destination.
            enum:
            - cname_flattening
          value:
            $ref: '#/components/schemas/zones_cname_flattening_value'
      title: Cloudflare CNAME Flattening
      description: Whether or not cname flattening is on.
    api-shield_type:
      type: string
      description: The type of characteristic.
      enum:
      - header
      - cookie
      example: header
    legacy-jhs_expression:
      type: string
      description: The filter expression. For more information, refer to [Expressions](https://developers.cloudflare.com/ruleset-engine/rules-language/expressions/).
      example: (http.request.uri.path ~ ".*wp-login.php" or http.request.uri.path ~ ".*xmlrpc.php") and ip.addr ne 172.16.22.155
    api-shield_openapiwiththresholds:
      type: object
      description: A OpenAPI 3.0.0 compliant schema.
      example:
        info:
          title: OpenAPI JSON schema for www.example.com
          version: '1.0'
        openapi: 3.0.0
        paths:
          '... Further paths ...': {}
          /api/v1/users/{var1}:
            get:
              parameters:
              - in: path
                name: var1
                required: true
                schema:
                  type: string
        servers:
        - url: www.example.com
    bot-management_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    dweb-config_content_list_action:
      type: string
      description: Behavior of the content list.
      enum:
      - block
      example: block
    tls-certificates-and-hostnames_custom_metadata:
      anyOf:
      - type: object
        properties:
          key:
            type: string
            description: Unique metadata for this hostname.
            example: value
      type: object
      description: These are per-hostname (customer) settings.
    secondary-dns_disable_transfer_response:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/secondary-dns_disable_transfer_result'
    tls-certificates-and-hostnames_keyless_response_collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless-certificate'
    dns-records_SVCBRecord:
      allOf:
      - properties:
          content:
            type: string
            description: Formatted SVCB content. See 'data' to set SVCB properties.
            readOnly: true
          data:
            type: object
            description: Components of a SVCB record.
            properties:
              priority:
                type: number
                description: priority.
                example: 1
                minimum: 0
                maximum: 65535
              target:
                type: string
                description: target.
                example: .
              value:
                type: string
                description: value.
                example: alpn="h3,h2" ipv4hint="127.0.0.1" ipv6hint="::1"
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - SVCB
            example: SVCB
      - $ref: '#/components/schemas/dns-records_base'
      title: SVCB Record
      required:
      - type
      - name
      - data
    bill-subs-api_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/bill-subs-api_messages'
        messages:
          $ref: '#/components/schemas/bill-subs-api_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    api-shield_kind:
      type: string
      description: Kind of schema
      enum:
      - openapi_v3
      example: openapi_v3
    waitingroom_description:
      type: string
      description: A note that you can use to add more details about the waiting room.
      default: ''
      example: Production - DO NOT MODIFY
    tls-certificates-and-hostnames_sslpost:
      oneOf:
      - type: object
        properties:
          bundle_method:
            type: string
            description: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.
            enum:
            - ubiquitous
            - optimal
            - force
            default: ubiquitous
            example: ubiquitous
          certificate_authority:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_authority'
          custom_certificate:
            type: string
            description: If a custom uploaded certificate is used.
            example: --BEGIN CERTIFICATE--\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\n--END CERTIFICATE--\n
          custom_key:
            type: string
            description: The key for a custom uploaded certificate.
            example: '--BEGIN RSA PRIVATE KEY--

              MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG

              dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn

              abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid

              tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py

              FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE

              ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb

              HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/

              axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb

              +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g

              +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv

              KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7

              9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo

              /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu

              iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9

              N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe

              VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB

              vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U

              lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR

              9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7

              mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX

              dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe

              PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS

              fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W

              qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T

              lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi

              --END RSA PRIVATE KEY--

              '
          method:
            description: Domain control validation (DCV) method used for this hostname.
            enum:
            - http
            - txt
            - email
            example: http
          settings:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_sslsettings'
          type:
            description: Level of validation to be used for this hostname. Domain validation (dv) must be used.
            enum:
            - dv
            example: dv
          wildcard:
            type: boolean
            description: Indicates whether the certificate covers a wildcard.
            example: false
      type: object
      description: SSL properties used when creating the custom hostname.
    legacy-jhs_package_components-schemas-status:
      type: string
      description: When set to `active`, indicates that the WAF package will be applied to the zone.
      enum:
      - active
      default: active
      readOnly: true
    data-zone-analytics-api_flag:
      type: boolean
      description: The log retention flag for Logpull API.
      example: true
    tls-certificates-and-hostnames_keyless_tunnel:
      type: object
      description: Configuration for using Keyless SSL through a Cloudflare Tunnel
      required:
      - private_ip
      - vnet_id
      properties:
        private_ip:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_private_ip'
        vnet_id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless_vnet_id'
    email_rule_catchall-actions:
      type: array
      description: List actions for the catch-all routing rule.
      items:
        $ref: '#/components/schemas/email_rule_catchall-action'
    load-balancing_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    legacy-jhs_disabled:
      type: boolean
      description: When true, indicates that the rate limit is currently disabled.
      example: false
    api-shield_suggested_threshold:
      type: integer
      description: The suggested threshold in requests done by the same auth_id or period_seconds.
      readOnly: true
    api-shield_operation_features:
      anyOf:
      - $ref: '#/components/schemas/api-shield_operation_feature_thresholds'
      - $ref: '#/components/schemas/api-shield_operation_feature_parameter_schemas'
      type: object
      readOnly: true
    access_decision:
      type: string
      description: The action Access will take if a user matches this policy.
      enum:
      - allow
      - deny
      - non_identity
      - bypass
      example: allow
    zones_targets:
      type: array
      description: The rule targets to evaluate on each request.
      example:
      - constraint:
          operator: matches
          value: '*example.com/images/*'
        target: url
      items:
        $ref: '#/components/schemas/zones_target'
    tls-certificates-and-hostnames_validation_method_components-schemas-status:
      type: string
      description: Result status.
      example: pending_validation
    access_logo_url:
      type: string
      description: The image URL for the logo shown in the App Launcher dashboard.
      example: https://www.cloudflare.com/img/logo-web-badges/cf-logo-on-white-bg.svg
    zones_brotli_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'off'
      - 'on'
      default: 'off'
    access_certificates_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/access_certificates'
    rulesets_RuleResponse:
      allOf:
      - $ref: '#/components/schemas/rulesets_RuleRequest'
      - required:
        - id
        - expression
        - action
        - ref
        - enabled
    waf-managed-rules_allowed_modes:
      type: array
      description: The available states for the rule group.
      example:
      - 'on'
      - 'off'
      readOnly: true
      items:
        $ref: '#/components/schemas/waf-managed-rules_mode'
    rulesets_RuleAction:
      type: string
      title: Action
      description: The action to perform when the rule matches.
      example: log
      pattern: ^[a-z]+$
    waitingroom_rule_position:
      oneOf:
      - type: object
        properties:
          index:
            type: integer
            description: ' Places the rule in the exact position specified by the integer number <POSITION_NUMBER>. Position numbers start with 1. Existing rules in the ruleset from the specified position number onward are shifted one position (no rule is overwritten).'
      - type: object
        properties:
          before:
            type: string
            description: ' Places the rule before rule <RULE_ID>. Use this argument with an empty rule ID value ("") to set the rule as the first rule in the ruleset.'
            example: <RULE_ID>
      - type: object
        properties:
          after:
            type: string
            description: Places the rule after rule <RULE_ID>. Use this argument with an empty rule ID value ("") to set the rule as the last rule in the ruleset.
            example: <RULE_ID>
      type: object
      description: Reorder the position of a rule
    rulesets_Errors:
      type: array
      title: Errors
      description: A list of error messages.
      items:
        $ref: '#/components/schemas/rulesets_Message'
    legacy-jhs_anomaly_detection_mode:
      type: string
      description: When a WAF package uses anomaly detection, each rule is given a score when triggered. If the total score of all triggered rules exceeds the sensitivity defined on the WAF package, the action defined on the package will be taken.
      example: anomaly
      readOnly: true
    access_policies_components-schemas-response_collection-2:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/access_schemas-policies'
    zones_schemas-api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/zones_messages'
        messages:
          $ref: '#/components/schemas/zones_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    email_rule_properties:
      type: object
      properties:
        actions:
          $ref: '#/components/schemas/email_rule_actions'
        enabled:
          $ref: '#/components/schemas/email_rule_enabled'
        id:
          $ref: '#/components/schemas/email_rule_identifier'
        matchers:
          $ref: '#/components/schemas/email_rule_matchers'
        name:
          $ref: '#/components/schemas/email_rule_name'
        priority:
          $ref: '#/components/schemas/email_rule_priority'
        tag:
          $ref: '#/components/schemas/email_rule_tag'
    zones_always_use_https:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - always_use_https
            example: always_use_https
          value:
            $ref: '#/components/schemas/zones_always_use_https_value'
      title: Zone Enable Always Use HTTPS
      description: Reply to all requests for URLs that use "http" with a 301 redirect to the equivalent "https" URL. If you only want to redirect for a subset of requests, consider creating an "Always use HTTPS" page rule.
      default: 'off'
    legacy-jhs_override:
      properties:
        description:
          $ref: '#/components/schemas/legacy-jhs_overrides_components-schemas-description'
        groups:
          $ref: '#/components/schemas/legacy-jhs_groups'
        id:
          $ref: '#/components/schemas/legacy-jhs_overrides_components-schemas-id'
        paused:
          $ref: '#/components/schemas/legacy-jhs_paused'
        priority:
          $ref: '#/components/schemas/legacy-jhs_components-schemas-priority'
        rewrite_action:
          $ref: '#/components/schemas/legacy-jhs_rewrite_action'
        rules:
          $ref: '#/components/schemas/legacy-jhs_rules'
        urls:
          $ref: '#/components/schemas/legacy-jhs_urls'
    zones_browser_check_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'on'
    waitingroom_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
    dweb-config_create_request:
      type: object
      required:
      - name
      - target
      properties:
        description:
          $ref: '#/components/schemas/dweb-config_description'
        dnslink:
          $ref: '#/components/schemas/dweb-config_dnslink'
        name:
          $ref: '#/components/schemas/dweb-config_name'
        target:
          $ref: '#/components/schemas/dweb-config_target'
    tls-certificates-and-hostnames_advanced_type:
      type: string
      description: Type of certificate pack.
      enum:
      - advanced
      example: advanced
    page-shield_list-zone-scripts-response:
      allOf:
      - $ref: '#/components/schemas/page-shield_api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/page-shield_script'
          result_info:
            $ref: '#/components/schemas/page-shield_result_info'
    zones_origin_error_page_pass_thru:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - origin_error_page_pass_thru
            example: origin_error_page_pass_thru
          value:
            $ref: '#/components/schemas/zones_origin_error_page_pass_thru_value'
      title: Error Pages On
      description: Cloudflare will proxy customer error pages on any 502,504 errors on origin server instead of showing a default Cloudflare error page. This does not apply to 522 errors and is limited to Enterprise Zones.
      default: 'off'
    legacy-jhs_ua-rules_components-schemas-id:
      type: string
      description: The unique identifier of the User Agent Blocking rule.
      example: 372e67954025e0ba6aaa6d586b9e0b59
      readOnly: true
      maxLength: 32
    access_access_group_rule:
      type: object
      title: Access groups
      description: Matches an Access group.
      required:
      - group
      properties:
        group:
          type: object
          required:
          - id
          properties:
            id:
              type: string
              description: The ID of a previously created Access group.
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
    tls-certificates-and-hostnames_client_certificate_response_collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_client_certificate'
    zones_sort_query_string_for_cache_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    legacy-jhs_schemas-until:
      type: string
      format: date-time
      description: End of time interval to query, defaults to current time. Timestamp must be in RFC3339 format and uses UTC unless otherwise specified.
      example: '2014-01-02T03:20:00Z'
    tls-certificates-and-hostnames_components-schemas-enabled:
      type: boolean
      description: If enabled, Total TLS will order a hostname specific TLS certificate for any proxied A, AAAA, or CNAME record in your zone.
      example: true
    tls-certificates-and-hostnames_per_hostname_settings_response:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            allOf:
            - $ref: '#/components/schemas/tls-certificates-and-hostnames_settingObject'
            type: object
    custom-pages_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/custom-pages_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/custom-pages_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    tls-certificates-and-hostnames_components-schemas-validation_method:
      type: object
      required:
      - validation_method
      properties:
        validation_method:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_method_definition'
    waitingroom_single_response:
      allOf:
      - $ref: '#/components/schemas/waitingroom_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/waitingroom_waitingroom'
    waitingroom_estimated_queued_users:
      type: integer
    access_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/access_uuid'
    tls-certificates-and-hostnames_keyless_response_single:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            allOf:
            - $ref: '#/components/schemas/tls-certificates-and-hostnames_base'
            type: object
    dns-custom-nameservers_zone_metadata:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether zone uses account-level custom nameservers.
          example: true
        ns_set:
          type: number
          description: The number of the name server set to assign to the zone.
          default: 1
          example: 1
          minimum: 1
          maximum: 5
    argo-analytics_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/argo-analytics_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/argo-analytics_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    access_approval_groups:
      type: array
      description: Administrators who can approve a temporary authentication request.
      example:
      - approvals_needed: 1
        email_addresses:
        - test1@cloudflare.com
        - test2@cloudflare.com
      - approvals_needed: 3
        email_list_uuid: 597147a1-976b-4ef2-9af0-81d5d007fc34
      items:
        $ref: '#/components/schemas/access_approval_group'
    access_schemas-saml_saas_app:
      type: object
      title: SAML SaaS App
      properties:
        auth_type:
          type: string
          description: Optional identifier indicating the authentication protocol used for the saas app. Required for OIDC. Default if unset is "saml"
          enum:
          - saml
          - oidc
          example: saml
        consumer_service_url:
          type: string
          description: The service provider's endpoint that is responsible for receiving and parsing a SAML assertion.
          example: https://example.com
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        custom_attributes:
          type: object
          properties:
            name:
              type: string
              description: The name of the attribute.
              example: family_name
            name_format:
              type: string
              description: A globally unique name for an identity or service provider.
              enum:
              - urn:oasis:names:tc:SAML:2.0:attrname-format:unspecified
              - urn:oasis:names:tc:SAML:2.0:attrname-format:basic
              - urn:oasis:names:tc:SAML:2.0:attrname-format:uri
              example: urn:oasis:names:tc:SAML:2.0:attrname-format:basic
            source:
              type: object
              properties:
                name:
                  type: string
                  description: The name of the IdP attribute.
                  example: last_name
        idp_entity_id:
          type: string
          description: The unique identifier for your SaaS application.
          example: https://example.cloudflareaccess.com
        name_id_format:
          type: string
          description: The format of the name identifier sent to the SaaS application.
          enum:
          - id
          - email
          example: id
        name_id_transform_jsonata:
          type: string
          description: 'A [JSONata](https://jsonata.org/) expression that transforms an application''s user identities into a NameID value for its SAML assertion. This expression should evaluate to a singular string. The output of this expression can override the `name_id_format` setting.

            '
          example: $substringBefore(email, '@') & '+sandbox@' & $substringAfter(email, '@')
        public_key:
          type: string
          description: The Access public certificate that will be used to verify your identity.
          example: example unique name
        sp_entity_id:
          type: string
          description: A globally unique name for an identity or service provider.
          example: example unique name
        sso_endpoint:
          type: string
          description: The endpoint where your SaaS application will send login requests.
          example: https://example.cloudflareaccess.com/cdn-cgi/access/sso/saml/b3f58a2b414e0b51d45c8c2af26fccca0e27c63763c426fa52f98dcf0b3b3bfd
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
    cache-purge_Everything:
      type: object
      properties:
        purge_everything:
          type: boolean
    workers_api-response-single:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    legacy-jhs_origin_dns:
      type: object
      description: The name and type of DNS record for the Spectrum application.
      properties:
        name:
          $ref: '#/components/schemas/legacy-jhs_origin_dns_name'
        ttl:
          $ref: '#/components/schemas/legacy-jhs_dns_ttl'
        type:
          $ref: '#/components/schemas/legacy-jhs_origin_dns_type'
    waf-managed-rules_traditional_allow_rule:
      allOf:
      - $ref: '#/components/schemas/waf-managed-rules_base'
      - properties:
          allowed_modes:
            $ref: '#/components/schemas/waf-managed-rules_allowed_modes_allow_traditional'
          mode:
            $ref: '#/components/schemas/waf-managed-rules_mode_allow_traditional'
      title: Traditional (allow) WAF rule
      description: When triggered, traditional WAF rules cause the firewall to immediately act on the request based on the rule configuration. An 'allow' rule will immediately allow the request and no other rules will be processed.
      required:
      - id
      - description
      - priority
      - allowed_modes
      - default_mode
      - mode
      - group
      - package_id
    api-shield_schema_response_with_thresholds:
      allOf:
      - $ref: '#/components/schemas/api-shield_default_response'
      - properties:
          result:
            type: object
            properties:
              schemas:
                type: array
                items:
                  $ref: '#/components/schemas/api-shield_openapiwiththresholds'
              timestamp:
                type: string
    access_components-schemas-domain:
      type: string
      description: The domain and path that Access will secure.
      example: test.example.com/admin
    zones_edge_cache_ttl:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - edge_cache_ttl
            example: edge_cache_ttl
          value:
            $ref: '#/components/schemas/zones_edge_cache_ttl_value'
      title: Edge Cache TTL
      description: Time (in seconds) that a resource will be ensured to remain on Cloudflare's cache servers.
    tls-certificates-and-hostnames_components-schemas-updated_at:
      type: string
      format: date-time
      description: This is the time the tls setting was updated.
      example: '2023-07-10T20:01:50.219171Z'
    access_schemas-saml:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            type: object
            properties:
              attributes:
                type: array
                description: A list of SAML attribute names that will be added to your signed JWT token and can be used in SAML policy rules.
                example:
                - group
                - department_code
                - divison
                items:
                  type: string
              email_attribute_name:
                type: string
                description: The attribute name for email in the SAML response.
                example: Email
              header_attributes:
                type: array
                description: Add a list of attribute names that will be returned in the response header from the Access callback.
                items:
                  type: object
                  properties:
                    attribute_name:
                      type: string
                      description: attribute name from the IDP
                    header_name:
                      type: string
                      description: header that will be added on the request to the origin
              idp_public_certs:
                type: array
                description: X509 certificate to verify the signature in the SAML authentication response
                items:
                  type: string
              issuer_url:
                type: string
                description: IdP Entity ID or Issuer URL
                example: https://whoami.com
              sign_request:
                type: boolean
                description: Sign the SAML authentication request with Access credentials. To verify the signature, use the public key from the Access certs endpoints.
              sso_target_url:
                type: string
                description: URL to send the SAML authentication requests to
                example: https://edgeaccess.org/idp/saml/login
      type: object
      title: Generic SAML
    tls-certificates-and-hostnames_advanced_certificate_pack_response_single:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - type: object
        properties:
          result:
            type: object
            properties:
              certificate_authority:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-certificate_authority'
              cloudflare_branding:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_cloudflare_branding'
              hosts:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hosts'
              id:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
              status:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate-packs_components-schemas-status'
              type:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_advanced_type'
              validation_method:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_method'
              validity_days:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_validity_days'
    observatory_pages-response-collection:
      allOf:
      - $ref: '#/components/schemas/observatory_api-response-collection'
      - properties:
          result:
            type: array
            items:
              properties:
                region:
                  $ref: '#/components/schemas/observatory_labeled_region'
                scheduleFrequency:
                  $ref: '#/components/schemas/observatory_schedule_frequency'
                tests:
                  type: array
                  items:
                    $ref: '#/components/schemas/observatory_page_test'
                url:
                  $ref: '#/components/schemas/observatory_url'
    legacy-jhs_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    page-shield_pageshield-policy-action:
      type: string
      description: The action to take if the expression matches
      enum:
      - allow
      - log
      example: allow
    legacy-jhs_override_response_collection:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-collection'
      - type: object
        required:
        - result
        properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/legacy-jhs_override'
              - type: object
                required:
                - id
                - paused
                - urls
                - priority
    legacy-jhs_zonelockdown_response_single:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - type: object
        required:
        - result
        properties:
          result:
            $ref: '#/components/schemas/legacy-jhs_zonelockdown'
    tls-certificates-and-hostnames_modified_on:
      type: string
      format: date-time
      description: When the certificate was last modified.
      example: '2014-01-01T05:20:00Z'
      readOnly: true
    dns-custom-nameservers_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    legacy-jhs_ratelimit:
      properties:
        action:
          $ref: '#/components/schemas/legacy-jhs_schemas-action'
        bypass:
          $ref: '#/components/schemas/legacy-jhs_bypass'
        description:
          $ref: '#/components/schemas/legacy-jhs_components-schemas-description'
        disabled:
          $ref: '#/components/schemas/legacy-jhs_disabled'
        id:
          $ref: '#/components/schemas/legacy-jhs_rate-limits_components-schemas-id'
        match:
          $ref: '#/components/schemas/legacy-jhs_match'
        period:
          $ref: '#/components/schemas/legacy-jhs_period'
        threshold:
          $ref: '#/components/schemas/legacy-jhs_threshold'
    api-shield_data_points:
      type: integer
      description: The number of data points used for the threshold suggestion calculation.
      readOnly: true
    email_email_setting_created:
      type: string
      format: date-time
      description: The date and time the settings have been created.
      example: '2014-01-02T02:20:00Z'
      readOnly: true
    tls-certificates-and-hostnames_schemas-signature:
      type: string
      description: Certificate's signature algorithm.
      enum:
      - ECDSAWithSHA256
      - SHA1WithRSA
      - SHA256WithRSA
    legacy-jhs_notes:
      type: string
      description: An informative summary of the rule, typically used as a reminder or explanation.
      example: This rule is enabled because of an event that occurred on date X.
    access_schemas-groups:
      type: object
      properties:
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        exclude:
          $ref: '#/components/schemas/access_exclude'
        id:
          $ref: '#/components/schemas/access_uuid'
        include:
          $ref: '#/components/schemas/access_include'
        name:
          $ref: '#/components/schemas/access_components-schemas-name'
        require:
          $ref: '#/components/schemas/access_require'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
    waitingroom_event_end_time:
      type: string
      description: An ISO 8601 timestamp that marks the end of the event.
      example: '2021-09-28T17:00:00.000Z'
    legacy-jhs_match:
      oneOf:
      - type: object
        properties:
          headers:
            type: array
            items:
              type: object
              properties:
                name:
                  $ref: '#/components/schemas/legacy-jhs_header_name'
                op:
                  $ref: '#/components/schemas/legacy-jhs_header_op'
                value:
                  $ref: '#/components/schemas/legacy-jhs_header_value'
          request:
            type: object
            properties:
              methods:
                $ref: '#/components/schemas/legacy-jhs_methods'
              schemes:
                $ref: '#/components/schemas/legacy-jhs_schemes'
              url:
                $ref: '#/components/schemas/legacy-jhs_schemas-url'
          response:
            type: object
            properties:
              origin_traffic:
                $ref: '#/components/schemas/legacy-jhs_origin_traffic'
      type: object
      description: Determines which traffic the rate limit counts towards the threshold.
    legacy-jhs_common_components-schemas-identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    access_purpose_justification_prompt:
      type: string
      description: A custom message that will appear on the purpose justification screen.
      example: Please enter a justification for entering this protected domain.
    rulesets_FailureResponse:
      type: object
      title: Failure response
      description: A failure response object.
      required:
      - result
      - success
      - errors
      - messages
      properties:
        errors:
          $ref: '#/components/schemas/rulesets_Errors'
        messages:
          $ref: '#/components/schemas/rulesets_Messages'
        result:
          title: Result
          description: A result.
          enum:
          - null
        success:
          type: boolean
          title: Success
          description: Whether the API call was successful.
          enum:
          - false
    dnssec_dnssec:
      type: object
      properties:
        algorithm:
          $ref: '#/components/schemas/dnssec_algorithm'
        digest:
          $ref: '#/components/schemas/dnssec_digest'
        digest_algorithm:
          $ref: '#/components/schemas/dnssec_digest_algorithm'
        digest_type:
          $ref: '#/components/schemas/dnssec_digest_type'
        dnssec_multi_signer:
          $ref: '#/components/schemas/dnssec_dnssec_multi_signer'
        dnssec_presigned:
          $ref: '#/components/schemas/dnssec_dnssec_presigned'
        ds:
          $ref: '#/components/schemas/dnssec_ds'
        flags:
          $ref: '#/components/schemas/dnssec_flags'
        key_tag:
          $ref: '#/components/schemas/dnssec_key_tag'
        key_type:
          $ref: '#/components/schemas/dnssec_key_type'
        modified_on:
          $ref: '#/components/schemas/dnssec_modified_on'
        public_key:
          $ref: '#/components/schemas/dnssec_public_key'
        status:
          $ref: '#/components/schemas/dnssec_status'
    snippets-api_snippet_name:
      type: string
      description: Snippet identifying name
      example: snippet_name_01
      pattern: ^[A-Za-z0-9_]+$
    waitingroom_event_id_response:
      allOf:
      - $ref: '#/components/schemas/waitingroom_api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/waitingroom_event_id'
    api-shield_zone_schema_validation_settings_patch:
      type: object
      properties:
        validation_default_mitigation_action:
          $ref: '#/components/schemas/api-shield_validation_default_mitigation_action_patch'
        validation_override_mitigation_action:
          $ref: '#/components/schemas/api-shield_validation_override_mitigation_action_patch'
    legacy-jhs_firewall-rules_components-schemas-id:
      type: string
      description: The unique identifier of the firewall rule.
      example: 372e67954025e0ba6aaa6d586b9e0b60
      readOnly: true
      maxLength: 32
    api-shield_schema_upload_failure:
      allOf:
      - properties:
          upload_details:
            $ref: '#/components/schemas/api-shield_schema_upload_details_errors_critical'
      - $ref: '#/components/schemas/api-shield_api-response-common-failure'
    tls-certificates-and-hostnames_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    custom-pages_custom_pages_response_single:
      allOf:
      - $ref: '#/components/schemas/custom-pages_api-response-single'
      - properties:
          result:
            type: object
    access_schemas-organizations:
      type: object
      properties:
        auth_domain:
          $ref: '#/components/schemas/access_auth_domain'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        is_ui_read_only:
          $ref: '#/components/schemas/access_is_ui_read_only'
        login_design:
          $ref: '#/components/schemas/access_login_design'
        name:
          $ref: '#/components/schemas/access_name'
        ui_read_only_toggle_reason:
          $ref: '#/components/schemas/access_ui_read_only_toggle_reason'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
        user_seat_expiration_inactive_time:
          $ref: '#/components/schemas/access_user_seat_expiration_inactive_time'
    dnssec_api-response-single:
      allOf:
      - $ref: '#/components/schemas/dnssec_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    bot-management_sbfm_likely_config:
      allOf:
      - $ref: '#/components/schemas/bot-management_sbfm_definitely_config'
      - properties:
          sbfm_likely_automated:
            $ref: '#/components/schemas/bot-management_sbfm_likely_automated'
      title: SBFM Biz Plan
    page-shield_resource_id:
      type: string
      description: The ID of the resource.
      example: c9ef84a6bf5e47138c75d95e2f933e8f
      minLength: 32
      maxLength: 32
    tls-certificates-and-hostnames_ownership_verification_http:
      oneOf:
      - type: object
        properties:
          http_body:
            type: string
            description: Token to be served.
            example: 5cc07c04-ea62-4a5a-95f0-419334a875a4
          http_url:
            type: string
            description: The HTTP URL that will be checked during custom hostname verification and where the customer should host the token.
            example: http://custom.test.com/.well-known/cf-custom-hostname-challenge/0d89c70d-ad9f-4843-b99f-6cc0252067e9
      type: object
      description: This presents the token to be served by the given http url to activate a hostname.
    email_rule_matchers:
      type: array
      description: Matching patterns to forward to your actions.
      items:
        $ref: '#/components/schemas/email_rule_matcher'
    legacy-jhs_schemas-action:
      anyOf:
      - type: object
        properties:
          mode:
            $ref: '#/components/schemas/legacy-jhs_mode'
          response:
            $ref: '#/components/schemas/legacy-jhs_custom_response'
          timeout:
            $ref: '#/components/schemas/legacy-jhs_timeout'
      type: object
      description: The action to perform when the threshold of matched traffic within the configured period is exceeded.
    logpush_error_message:
      type: string
      format: date-time
      description: 'If not null, the job is currently failing. Failures are usually repetitive (example: no permissions to write to destination bucket). Only the last failure is recorded. On successful execution of a job the error_message and last_error are set to null.'
      nullable: true
    legacy-jhs_custom_response:
      anyOf:
      - type: object
        properties:
          body:
            $ref: '#/components/schemas/legacy-jhs_body'
          content_type:
            $ref: '#/components/schemas/legacy-jhs_content_type'
      type: object
      description: 'A custom content type and reponse to return when the threshold is exceeded. The custom response configured in this object will override the custom error for the zone. This object is optional.

        Notes: If you omit this object, Cloudflare will use the default HTML error page. If "mode" is "challenge", "managed_challenge", or "js_challenge", Cloudflare will use the zone challenge pages and you should not provide the "response" object.'
    rulesets_ExecuteSensitivityLevel:
      type: string
      title: Sensitivity level
      enum:
      - default
      - medium
      - low
      - eoff
    cache_regional_tiered_cache:
      allOf:
      - $ref: '#/components/schemas/cache_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - tc_regional
            example: tc_regional
      title: Regional Tiered Cache
      description: Instructs Cloudflare to check a regional hub data center on the way to your upper tier. This can help improve performance for smart and custom tiered cache topologies.
    access_email_rule:
      type: object
      title: Email
      description: Matches a specific email.
      required:
      - email
      properties:
        email:
          type: object
          required:
          - email
          properties:
            email:
              type: string
              format: email
              description: The email of the user.
              example: test@example.com
    logpush_last_complete:
      type: string
      format: date-time
      description: Records the last time for which logs have been successfully pushed. If the last successful push was for logs range 2018-07-23T10:00:00Z to 2018-07-23T10:01:00Z then the value of this field will be 2018-07-23T10:01:00Z. If the job has never run or has just been enabled and hasn't run yet then the field will be empty.
      nullable: true
    tls-certificates-and-hostnames_certificate_pack_response_collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
      - properties:
          result:
            type: array
            items:
              type: object
    legacy-jhs_components-schemas-modified_on:
      type: string
      format: date-time
      description: The timestamp of when the rule was last modified.
      example: '2014-01-01T05:20:00.12345Z'
      readOnly: true
    access_associated_hostnames:
      type: array
      description: The hostnames of the applications that will use this certificate.
      items:
        type: string
        description: A fully-qualified domain name (FQDN).
        example: admin.example.com
    speed_base:
      required:
      - id
      - value
      properties:
        editable:
          type: boolean
          description: Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).
          enum:
          - true
          - false
          default: true
          readOnly: true
        id:
          type: string
          description: Identifier of the zone setting.
          example: development_mode
        modified_on:
          type: string
          format: date-time
          description: last time this setting was modified.
          example: '2014-01-01T05:20:00.12345Z'
          nullable: true
          readOnly: true
        value:
          description: Current value of the zone setting.
          example: 'on'
    api-shield_patch_discovery_response:
      allOf:
      - $ref: '#/components/schemas/api-shield_api-response-single'
      - properties:
          result:
            type: object
            properties:
              state:
                $ref: '#/components/schemas/api-shield_api_discovery_state'
    waitingroom_response_collection:
      allOf:
      - $ref: '#/components/schemas/waitingroom_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/waitingroom_waitingroom'
    tls-certificates-and-hostnames_verification_status:
      type: boolean
      description: Status of the required verification information, omitted if verification status is unknown.
      example: true
    dweb-config_content_list_entry_type:
      type: string
      description: Type of content list entry to block.
      enum:
      - cid
      - content_path
      example: cid
    cache_cache_reserve_clear_end_ts:
      type: string
      format: date-time
      description: The time that the latest Cache Reserve Clear operation completed.
      example: '2023-10-02T12:00:00.12345Z'
    legacy-jhs_rate-limits_components-schemas-id:
      type: string
      description: The unique identifier of the rate limit.
      example: 372e67954025e0ba6aaa6d586b9e0b59
      readOnly: true
      maxLength: 32
    zones_pseudo_ipv4:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: Value of the Pseudo IPv4 setting.
            enum:
            - pseudo_ipv4
            default: pseudo_ipv4
          value:
            $ref: '#/components/schemas/zones_pseudo_ipv4_value'
      title: Pseudo IPv4 Value
      description: The value set for the Pseudo IPv4 setting.
    access_certificates:
      type: object
      properties:
        associated_hostnames:
          $ref: '#/components/schemas/access_associated_hostnames'
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        expires_on:
          $ref: '#/components/schemas/access_timestamp'
        fingerprint:
          $ref: '#/components/schemas/access_fingerprint'
        id:
          description: The ID of the application that will use this certificate.
        name:
          $ref: '#/components/schemas/access_certificates_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
    workers_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/workers_messages'
        messages:
          $ref: '#/components/schemas/workers_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    email_rule_identifier:
      type: string
      description: Routing rule identifier.
      example: a7e6fb77503c41d8a7f3113c6918f10c
      readOnly: true
      maxLength: 32
    zones_priority:
      type: integer
      description: 'The priority of the rule, used to define which Page Rule is processed over another. A higher number indicates a higher priority. For example, if you have a catch-all Page Rule (rule A: `/images/*`) but want a more specific Page Rule to take precedence (rule B: `/images/special/*`), specify a higher priority for rule B so it overrides rule A.'
      default: 1
    bill-subs-api_name:
      type: string
      description: The domain name
      example: example.com
      readOnly: true
      maxLength: 253
      pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$
    rulesets_RulesetResponse:
      allOf:
      - $ref: '#/components/schemas/rulesets_Ruleset'
      - required:
        - name
        - kind
        - phase
        - rules
        properties:
          rules:
            $ref: '#/components/schemas/rulesets_RulesResponse'
    waitingroom_event_custom_page_html:
      type: string
      description: If set, the event will override the waiting room's `custom_page_html` property while it is active. If null, the event will inherit it.
      example: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Event is prequeueing / Queue all enabled {{/waitTimeKnown}}'
      nullable: true
    tls-certificates-and-hostnames_components-schemas-hostname:
      type: string
      description: The hostname for which the tls settings are set.
      example: app.example.com
    legacy-jhs_schemas-filter-response-collection:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/legacy-jhs_filter'
              - type: object
                required:
                - id
                - expression
                - paused
    secondary-dns_id_response:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/secondary-dns_identifier'
    access_schemas-custom_deny_url:
      type: string
      description: The custom URL a user is redirected to when they are denied access to the application.
    legacy-jhs_api-response-single:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
            nullable: true
      type: object
    zones_security_header_value:
      type: object
      default:
        strict_transport_security:
          enabled: true
          include_subdomains: true
          max_age: 86400
          nosniff: true
      properties:
        strict_transport_security:
          type: object
          description: Strict Transport Security.
          properties:
            enabled:
              type: boolean
              description: Whether or not strict transport security is enabled.
              example: true
            include_subdomains:
              type: boolean
              description: Include all subdomains for strict transport security.
              example: true
            max_age:
              type: number
              description: Max age in seconds of the strict transport security.
              example: 86400
            nosniff:
              type: boolean
              description: 'Whether or not to include ''X-Content-Type-Options: nosniff'' header.'
              example: true
    cache_variants:
      allOf:
      - $ref: '#/components/schemas/cache_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - variants
            example: variants
      title: Variants Caching
      description: 'Variant support enables caching variants of images with certain file extensions in addition to the original. This only applies when the origin server sends the ''Vary: Accept'' response header. If the origin server sends ''Vary: Accept'' but does not serve the variant requested, the response will not be cached. This will be indicated with BYPASS cache status in the response headers.'
    zones_mobile_redirect_value:
      type: object
      description: Value of the zone setting.
      default:
        mobile_subdomain: null
        status: 'off'
        strip_uri: false
      properties:
        mobile_subdomain:
          type: string
          description: Which subdomain prefix you wish to redirect visitors on mobile devices to (subdomain must already exist).
          example: m
          nullable: true
          minLength: 1
        status:
          description: Whether or not mobile redirect is enabled.
          enum:
          - 'on'
          - 'off'
          default: 'off'
        strip_uri:
          type: boolean
          description: Whether to drop the current page path and redirect to the mobile subdomain URL root, or keep the path and redirect to the same page on the mobile subdomain.
          default: false
          example: false
    waitingroom_custom_page_html:
      type: string
      description: "Only available for the Waiting Room Advanced subscription. This is a template html file that will be rendered at the edge. If no custom_page_html is provided, the default waiting room will be used. The template is based on mustache ( https://mustache.github.io/ ). There are several variables that are evaluated by the Cloudflare edge:\n1. {{`waitTimeKnown`}} Acts like a boolean value that indicates the behavior to take when wait time is not available, for instance when queue_all is **true**. \n2. {{`waitTimeFormatted`}} Estimated wait time for the user. For example, five minutes. Alternatively, you can use: \n3. {{`waitTime`}} Number of minutes of estimated wait for a user.\n4. {{`waitTimeHours`}} Number of hours of estimated wait for a user (`Math.floor(waitTime/60)`). \n5. {{`waitTimeHourMinutes`}} Number of minutes above the `waitTimeHours` value (`waitTime%60`). \n6. {{`queueIsFull`}} Changes to **true** when no more people can be added to the queue.\n\nTo view the full list of variables, look at the `cfWaitingRoom` object described under the `json_response_enabled` property in other Waiting Room API calls."
      default: ''
      example: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}} Queue all enabled {{/waitTimeKnown}}'
    secondary-dns_single_request_outgoing:
      required:
      - id
      - name
      - peers
      properties:
        id:
          $ref: '#/components/schemas/secondary-dns_identifier'
        name:
          $ref: '#/components/schemas/secondary-dns_name'
        peers:
          $ref: '#/components/schemas/secondary-dns_peers'
    access_settings:
      type: object
      title: Hostname Settings
      required:
      - hostname
      - china_network
      - client_certificate_forwarding
      properties:
        china_network:
          type: boolean
          description: Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.
          example: false
        client_certificate_forwarding:
          type: boolean
          description: Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.
          example: true
        hostname:
          type: string
          description: The hostname that these settings apply to.
          example: admin.example.com
    dns-custom-nameservers_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    data-zone-analytics-api_bandwidth:
      type: object
      description: Breakdown of totals for bandwidth in the form of bytes.
      properties:
        all:
          type: integer
          description: The total number of bytes served within the time frame.
        cached:
          type: integer
          description: The number of bytes that were cached (and served) by Cloudflare.
        content_type:
          type: object
          description: A variable list of key/value pairs where the key represents the type of content served, and the value is the number in bytes served.
          example:
            css: 237421
            gif: 1234242
            html: 1231290
            javascript: 123245
            jpeg: 784278
        country:
          type: object
          description: A variable list of key/value pairs where the key is a two-digit country code and the value is the number of bytes served to that country.
          example:
            AG: 2342483
            GI: 984753
            US: 123145433
        ssl:
          type: object
          description: A break down of bytes served over HTTPS.
          properties:
            encrypted:
              type: integer
              description: The number of bytes served over HTTPS.
            unencrypted:
              type: integer
              description: The number of bytes served over HTTP.
        ssl_protocols:
          type: object
          description: A breakdown of requests by their SSL protocol.
          properties:
            TLSv1:
              type: integer
              description: The number of requests served over TLS v1.0.
            TLSv1.1:
              type: integer
              description: The number of requests served over TLS v1.1.
            TLSv1.2:
              type: integer
              description: The number of requests served over TLS v1.2.
            TLSv1.3:
              type: integer
              description: The number of requests served over TLS v1.3.
            none:
              type: integer
              description: The number of requests served over HTTP.
        uncached:
          type: integer
          description: The number of bytes that were fetched and served from the origin server.
    workers_filter-response-single:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/workers_filters'
    dweb-config_dnslink:
      type: string
      description: DNSLink value used if the target is ipfs.
      example: /ipns/onboarding.ipfs.cloudflare.com
    waitingroom_event_details_session_duration:
      type: integer
    access_service_token_rule:
      type: object
      title: Service Token
      description: Matches a specific Access Service Token
      required:
      - service_token
      properties:
        service_token:
          type: object
          required:
          - token_id
          properties:
            token_id:
              type: string
              description: The ID of a Service Token.
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
    zones_orange_to_orange:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - orange_to_orange
            example: orange_to_orange
          value:
            $ref: '#/components/schemas/zones_orange_to_orange_value'
      title: Orange to Orange
      description: Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other zones also on Cloudflare.
    bot-management_bot_management_response_body:
      allOf:
      - $ref: '#/components/schemas/bot-management_api-response-single'
      - type: object
        properties:
          result:
            oneOf:
            - $ref: '#/components/schemas/bot-management_bot_fight_mode_config'
            - $ref: '#/components/schemas/bot-management_sbfm_definitely_config'
            - $ref: '#/components/schemas/bot-management_sbfm_likely_config'
            - $ref: '#/components/schemas/bot-management_bm_subscription_config'
    zones_mirage_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-expires_on:
      type: string
      format: date-time
      description: The date when the certificate expires.
      example: '2100-01-01T05:20:00Z'
      readOnly: true
    secondary-dns_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    legacy-jhs_ipv6_configuration:
      title: An IPv6 address configuration.
      properties:
        target:
          description: The configuration target. You must set the target to `ip6` when specifying an IPv6 address in the rule.
          enum:
          - ip6
          example: ip6
        value:
          type: string
          description: The IPv6 address to match.
          example: 2001:DB8:100::CF
    bill-subs-api_can_subscribe:
      type: boolean
      description: Indicates whether you can subscribe to this plan.
      default: false
      example: true
    legacy-jhs_ua-rules_components-schemas-description:
      type: string
      description: An informative summary of the rule.
      example: Prevent access from abusive clients identified by this User Agent to mitigate a DDoS attack
      maxLength: 1024
    workers_schemas-binding:
      oneOf:
      - $ref: '#/components/schemas/workers_kv_namespace_binding'
      - $ref: '#/components/schemas/workers_wasm_module_binding'
    zones_opportunistic_encryption_value:
      type: string
      description: 'Value of the zone setting.

        Notes: Default value depends on the zone''s plan level.'
      enum:
      - 'on'
      - 'off'
      default: 'on'
    data-zone-analytics-api_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    rulesets_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    tls-certificates-and-hostnames_certificate_response_single:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            type: object
    legacy-jhs_ratelimit_response_single:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - type: object
        properties:
          result:
            type: object
    waitingroom_event_session_duration:
      type: integer
      description: If set, the event will override the waiting room's `session_duration` property while it is active. If null, the event will inherit it.
      nullable: true
      minimum: 1
      maximum: 30
    observatory_page-test-response-collection:
      allOf:
      - $ref: '#/components/schemas/observatory_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/observatory_page_test'
      - properties:
          result_info:
            $ref: '#/components/schemas/observatory_result_info'
    workers_kv_namespace_binding:
      type: object
      required:
      - name
      - type
      - namespace_id
      properties:
        name:
          $ref: '#/components/schemas/workers_binding_name'
        namespace_id:
          $ref: '#/components/schemas/workers_namespace_identifier'
        type:
          type: string
          description: The class of resource that the binding provides.
          enum:
          - kv_namespace
          example: kv_namespace
    tls-certificates-and-hostnames_cert_pack_uuid:
      type: string
      description: Certificate Pack UUID.
      example: a77f8bd7-3b47-46b4-a6f1-75cf98109948
    tls-certificates-and-hostnames_host:
      type: string
      format: hostname
      description: The keyless SSL name.
      example: example.com
      maxLength: 253
    bill-subs-api_is_subscribed:
      type: boolean
      description: Indicates whether you are currently subscribed to this plan.
      default: false
      example: false
    cache_schemas-value:
      type: string
      description: Enables Tiered Cache.
      enum:
      - 'on'
      - 'off'
      example: 'on'
    observatory_schedule-response-single:
      allOf:
      - $ref: '#/components/schemas/observatory_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/observatory_schedule'
    email_rule_actions:
      type: array
      description: List actions patterns.
      items:
        $ref: '#/components/schemas/email_rule_action'
    page-shield_get-zone-policy-response:
      allOf:
      - $ref: '#/components/schemas/page-shield_pageshield-policy'
    data-zone-analytics-api_dashboard_response:
      allOf:
      - $ref: '#/components/schemas/data-zone-analytics-api_api-response-single'
      - properties:
          query:
            $ref: '#/components/schemas/data-zone-analytics-api_query_response'
          result:
            $ref: '#/components/schemas/data-zone-analytics-api_dashboard'
    zones_cache_level_value:
      type: string
      description: Value of the zone setting.
      enum:
      - aggressive
      - basic
      - simplified
      default: aggressive
    tls-certificates-and-hostnames_schemas-hosts:
      type: array
      description: Comma separated list of valid host names for the certificate packs. Must contain the zone apex, may not contain more than 50 hosts, and may not be empty.
      example:
      - example.com
      - '*.example.com'
      - www.example.com
      items:
        type: string
    dweb-config_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    zaraz_zaraz-config-base:
      type: object
      description: Zaraz configuration
      example:
        consent:
          cookieName: zaraz-consent
          customIntroDisclaimerDismissed: true
          enabled: false
        dataLayer: true
        debugKey: my-debug-key
        settings:
          autoInjectScript: true
          ecommerce: true
          initPath: /i
        tools:
          aJvt:
            actions:
              hrnc:
                actionType: pageview
                blockingTriggers: []
                data:
                  __zaraz_setting_name: Page view
                  ev: PageView
                firingTriggers:
                - Pageview
            component: facebook-pixel
            defaultFields:
              testKey: TEST123456
            enabled: true
            name: Facebook Pixel
            permissions:
            - access_client_kv
            settings:
              accessToken: ABcdEFg
              ecommerce: true
              property: '12345'
            type: component
        triggers:
          ktBn:
            Pageview:
              clientRules: []
              description: All page loads
              excludeRules: []
              loadRules:
              - match: '{{ client.__zarazTrack }}'
                op: EQUALS
                value: Pageview
              name: Pageview
              system: pageload
        variables:
          Autd:
            name: ip
            type: string
            value: '{{ system.device.ip }}'
        zarazVersion: 43
      required:
      - tools
      - triggers
      - variables
      - settings
      - dataLayer
      - debugKey
      - zarazVersion
      properties:
        consent:
          type: object
          description: Consent management configuration.
          required:
          - enabled
          properties:
            buttonTextTranslations:
              type: object
              required:
              - accept_all
              - reject_all
              - confirm_my_choices
              properties:
                accept_all:
                  type: object
                  description: Object where keys are language codes
                confirm_my_choices:
                  type: object
                  description: Object where keys are language codes
                reject_all:
                  type: object
                  description: Object where keys are language codes
            companyEmail:
              type: string
            companyName:
              type: string
            companyStreetAddress:
              type: string
            consentModalIntroHTML:
              type: string
            consentModalIntroHTMLWithTranslations:
              type: object
              description: Object where keys are language codes
            cookieName:
              type: string
            customCSS:
              type: string
            customIntroDisclaimerDismissed:
              type: boolean
            defaultLanguage:
              type: string
            enabled:
              type: boolean
            hideModal:
              type: boolean
            purposes:
              type: object
              description: Object where keys are purpose alpha-numeric IDs
            purposesWithTranslations:
              type: object
              description: Object where keys are purpose alpha-numeric IDs
        dataLayer:
          type: boolean
          description: Data layer compatibility mode enabled.
        debugKey:
          type: string
          description: The key for Zaraz debug mode.
        historyChange:
          type: boolean
          description: Single Page Application support enabled.
        settings:
          type: object
          description: General Zaraz settings.
          required:
          - autoInjectScript
          properties:
            autoInjectScript:
              type: boolean
              description: Automatic injection of Zaraz scripts enabled.
            contextEnricher:
              type: object
              description: Details of the worker that receives and edits Zaraz Context object.
              required:
              - escapedWorkerName
              - workerTag
              properties:
                escapedWorkerName:
                  type: string
                workerTag:
                  type: string
            cookieDomain:
              type: string
              description: The domain Zaraz will use for writing and reading its cookies.
            ecommerce:
              type: boolean
              description: Ecommerce API enabled.
            eventsApiPath:
              type: string
              description: Custom endpoint for server-side track events.
            hideExternalReferer:
              type: boolean
              description: Hiding external referrer URL enabled.
            hideIPAddress:
              type: boolean
              description: Trimming IP address enabled.
            hideQueryParams:
              type: boolean
              description: Removing URL query params enabled.
            hideUserAgent:
              type: boolean
              description: Removing sensitive data from User Aagent string enabled.
            initPath:
              type: string
              description: Custom endpoint for Zaraz init script.
            injectIframes:
              type: boolean
              description: Injection of Zaraz scripts into iframes enabled.
            mcRootPath:
              type: string
              description: Custom path for Managed Components server functionalities.
            scriptPath:
              type: string
              description: Custom endpoint for Zaraz main script.
            trackPath:
              type: string
              description: Custom endpoint for Zaraz tracking requests.
        triggers:
          type: object
          description: Triggers set up under Zaraz configuration, where key is the trigger alpha-numeric ID and value is the trigger configuration.
        variables:
          type: object
          description: Variables set up under Zaraz configuration, where key is the variable alpha-numeric ID and value is the variable configuration. Values of variables of type secret are not included.
        zarazVersion:
          type: integer
          description: Zaraz internal version of the config.
    api-shield_name:
      type: string
      description: The name of the characteristic field, i.e., the header or cookie name.
      example: authorization
      maxLength: 128
    bot-management_enable_js:
      type: boolean
      description: Use lightweight, invisible JavaScript detections to improve Bot Management. [Learn more about JavaScript Detections](https://developers.cloudflare.com/bots/reference/javascript-detections/).
      example: true
    bill-subs-api_subscription-v2:
      type: object
      properties:
        app:
          properties:
            install_id:
              $ref: '#/components/schemas/bill-subs-api_install_id'
        component_values:
          $ref: '#/components/schemas/bill-subs-api_component_values'
        currency:
          $ref: '#/components/schemas/bill-subs-api_currency'
        current_period_end:
          $ref: '#/components/schemas/bill-subs-api_current_period_end'
        current_period_start:
          $ref: '#/components/schemas/bill-subs-api_current_period_start'
        frequency:
          $ref: '#/components/schemas/bill-subs-api_frequency'
        id:
          $ref: '#/components/schemas/bill-subs-api_schemas-identifier'
        price:
          $ref: '#/components/schemas/bill-subs-api_price'
        rate_plan:
          $ref: '#/components/schemas/bill-subs-api_rate_plan'
        state:
          $ref: '#/components/schemas/bill-subs-api_state'
        zone:
          $ref: '#/components/schemas/bill-subs-api_zone'
    bot-management_sbfm_verified_bots:
      type: string
      description: Super Bot Fight Mode (SBFM) action to take on verified bots requests.
      enum:
      - allow
      - block
      example: allow
    legacy-jhs_mode:
      type: string
      description: The action to perform.
      enum:
      - simulate
      - ban
      - challenge
      - js_challenge
      - managed_challenge
      example: challenge
    zones_http2_value:
      type: string
      description: Value of the HTTP2 setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    legacy-jhs_rule:
      type: object
      required:
      - id
      - mode
      - allowed_modes
      - configuration
      properties:
        allowed_modes:
          type: array
          description: The available actions that a rule can apply to a matched request.
          example:
          - whitelist
          - block
          - challenge
          - js_challenge
          - managed_challenge
          readOnly: true
          items:
            $ref: '#/components/schemas/legacy-jhs_schemas-mode'
        configuration:
          $ref: '#/components/schemas/legacy-jhs_schemas-configuration'
        created_on:
          type: string
          format: date-time
          description: The timestamp of when the rule was created.
          example: '2014-01-01T05:20:00.12345Z'
          readOnly: true
        id:
          $ref: '#/components/schemas/legacy-jhs_rule_components-schemas-identifier'
        mode:
          $ref: '#/components/schemas/legacy-jhs_schemas-mode'
        modified_on:
          type: string
          format: date-time
          description: The timestamp of when the rule was last modified.
          example: '2014-01-01T05:20:00.12345Z'
          readOnly: true
        notes:
          $ref: '#/components/schemas/legacy-jhs_notes'
    page-shield_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    rulesets_RulesResponse:
      type: array
      title: Rules
      description: The list of rules in the ruleset.
      items:
        $ref: '#/components/schemas/rulesets_RuleResponse'
    data-zone-analytics-api_uniques:
      type: object
      properties:
        all:
          type: integer
          description: Total number of unique IP addresses within the time range.
    zones_challenge_ttl:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - challenge_ttl
            example: challenge_ttl
          value:
            $ref: '#/components/schemas/zones_challenge_ttl_value'
      title: Challenge Page TTL
      description: Specify how long a visitor is allowed access to your site after successfully completing a challenge (such as a CAPTCHA). After the TTL has expired the visitor will have to complete a new challenge. We recommend a 15 - 45 minute setting and will attempt to honor any setting above 45 minutes. (https://support.cloudflare.com/hc/en-us/articles/200170136).
    zones_proxy_read_timeout:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - proxy_read_timeout
            example: proxy_read_timeout
          value:
            $ref: '#/components/schemas/zones_proxy_read_timeout_value'
      title: Proxy Read Timeout
      description: Maximum time between two read operations from origin.
    email_rule_response_single:
      allOf:
      - $ref: '#/components/schemas/email_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/email_rules'
    cache-purge_identifier:
      type: string
    waf-managed-rules_group:
      type: object
      properties:
        description:
          $ref: '#/components/schemas/waf-managed-rules_description'
        id:
          $ref: '#/components/schemas/waf-managed-rules_components-schemas-identifier'
        modified_rules_count:
          $ref: '#/components/schemas/waf-managed-rules_modified_rules_count'
        name:
          $ref: '#/components/schemas/waf-managed-rules_name'
        package_id:
          $ref: '#/components/schemas/waf-managed-rules_identifier'
        rules_count:
          $ref: '#/components/schemas/waf-managed-rules_rules_count'
    dns-records_ARecord:
      allOf:
      - properties:
          content:
            type: string
            format: ipv4
            description: A valid IPv4 address.
            example: 198.51.100.4
          name:
            $ref: '#/components/schemas/dns-records_name'
          proxied:
            $ref: '#/components/schemas/dns-records_proxied'
          type:
            type: string
            description: Record type.
            enum:
            - A
            example: A
      - $ref: '#/components/schemas/dns-records_base'
      title: A Record
      required:
      - type
      - name
      - content
    cache_origin_max_http_version_value:
      type: string
      description: Value of the Origin Max HTTP Version Setting.
      enum:
      - '2'
      - '1'
    legacy-jhs_anomaly_description:
      type: string
      description: A summary of the purpose/function of the WAF package.
      example: Covers OWASP Top 10 vulnerabilities and more.
      readOnly: true
    waitingroom_cookie_attributes:
      type: object
      description: Configures cookie attributes for the waiting room cookie. This encrypted cookie stores a user's status in the waiting room, such as queue position.
      properties:
        samesite:
          type: string
          description: Configures the SameSite attribute on the waiting room cookie. Value `auto` will be translated to `lax` or `none` depending if **Always Use HTTPS** is enabled. Note that when using value `none`, the secure attribute cannot be set to `never`.
          enum:
          - auto
          - lax
          - none
          - strict
          default: auto
          example: auto
        secure:
          type: string
          description: Configures the Secure attribute on the waiting room cookie. Value `always` indicates that the Secure attribute will be set in the Set-Cookie header, `never` indicates that the Secure attribute will not be set, and `auto` will set the Secure attribute depending if **Always Use HTTPS** is enabled.
          enum:
          - auto
          - always
          - never
          default: auto
          example: auto
    access_everyone_rule:
      type: object
      title: Everyone
      description: Matches everyone.
      required:
      - everyone
      properties:
        everyone:
          type: object
          description: An empty object which matches on all users.
          example: {}
    argo-analytics_response_single:
      allOf:
      - $ref: '#/components/schemas/argo-analytics_api-response-single'
      - type: object
        properties:
          result:
            type: object
    waitingroom_query_waitingroom:
      type: object
      required:
      - name
      - host
      - new_users_per_minute
      - total_active_users
      properties:
        additional_routes:
          $ref: '#/components/schemas/waitingroom_additional_routes'
        cookie_attributes:
          $ref: '#/components/schemas/waitingroom_cookie_attributes'
        cookie_suffix:
          $ref: '#/components/schemas/waitingroom_cookie_suffix'
        custom_page_html:
          $ref: '#/components/schemas/waitingroom_custom_page_html'
        default_template_language:
          $ref: '#/components/schemas/waitingroom_default_template_language'
        description:
          $ref: '#/components/schemas/waitingroom_description'
        disable_session_renewal:
          $ref: '#/components/schemas/waitingroom_disable_session_renewal'
        host:
          $ref: '#/components/schemas/waitingroom_host'
        json_response_enabled:
          $ref: '#/components/schemas/waitingroom_json_response_enabled'
        name:
          $ref: '#/components/schemas/waitingroom_name'
        new_users_per_minute:
          $ref: '#/components/schemas/waitingroom_new_users_per_minute'
        path:
          $ref: '#/components/schemas/waitingroom_path'
        queue_all:
          $ref: '#/components/schemas/waitingroom_queue_all'
        queueing_method:
          $ref: '#/components/schemas/waitingroom_queueing_method'
        queueing_status_code:
          $ref: '#/components/schemas/waitingroom_queueing_status_code'
        session_duration:
          $ref: '#/components/schemas/waitingroom_session_duration'
        suspended:
          $ref: '#/components/schemas/waitingroom_suspended'
        total_active_users:
          $ref: '#/components/schemas/waitingroom_total_active_users'
    dns-records_NAPTRRecord:
      allOf:
      - properties:
          content:
            type: string
            description: Formatted NAPTR content. See 'data' to set NAPTR properties.
            readOnly: true
          data:
            type: object
            description: Components of a NAPTR record.
            properties:
              flags:
                type: string
                description: Flags.
              order:
                type: number
                description: Order.
                example: 100
                minimum: 0
                maximum: 65535
              preference:
                type: number
                description: Preference.
                example: 10
                minimum: 0
                maximum: 65535
              regex:
                type: string
                description: Regex.
              replacement:
                type: string
                description: Replacement.
              service:
                type: string
                description: Service.
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - NAPTR
            example: NAPTR
      - $ref: '#/components/schemas/dns-records_base'
      title: NAPTR Record
      required:
      - type
      - name
      - data
    dns-records_SRVRecord:
      allOf:
      - properties:
          content:
            type: string
            description: Priority, weight, port, and SRV target. See 'data' for setting the individual component values.
            example: 10 IN SRV 5 8806 example.com.
            readOnly: true
          data:
            type: object
            description: Components of a SRV record.
            properties:
              name:
                type: string
                format: hostname
                description: A valid hostname. Deprecated in favor of the regular 'name' outside the data map. This data map field represents the remainder of the full 'name' after the service and protocol.
                example: example.com
                deprecated: true
              port:
                type: number
                description: The port of the service.
                example: 8806
                minimum: 0
                maximum: 65535
              priority:
                $ref: '#/components/schemas/dns-records_priority'
              proto:
                type: string
                description: A valid protocol, prefixed with an underscore. Deprecated in favor of the regular 'name' outside the data map. This data map field normally represents the second label of that 'name'.
                example: _tcp
                deprecated: true
              service:
                type: string
                description: A service type, prefixed with an underscore. Deprecated in favor of the regular 'name' outside the data map. This data map field normally represents the first label of that 'name'.
                example: _sip
                deprecated: true
              target:
                type: string
                format: hostname
                description: A valid hostname.
                example: example.com
              weight:
                type: number
                description: The record weight.
                example: 5
                minimum: 0
                maximum: 65535
          name:
            type: string
            description: DNS record name (or @ for the zone apex) in Punycode. For SRV records, the first label is normally a service and the second a protocol name, each starting with an underscore.
            example: _sip._tcp.example.com
            maxLength: 255
          type:
            type: string
            description: Record type.
            enum:
            - SRV
            example: SRV
      - $ref: '#/components/schemas/dns-records_base'
      title: SRV Record
      required:
      - type
      - name
      - data
    waitingroom_patch_rule:
      required:
      - action
      - expression
      properties:
        action:
          $ref: '#/components/schemas/waitingroom_rule_action'
        description:
          $ref: '#/components/schemas/waitingroom_rule_description'
        enabled:
          $ref: '#/components/schemas/waitingroom_rule_enabled'
        expression:
          $ref: '#/components/schemas/waitingroom_rule_expression'
        position:
          $ref: '#/components/schemas/waitingroom_rule_position'
    api-shield_configuration:
      type: object
      properties:
        auth_id_characteristics:
          $ref: '#/components/schemas/api-shield_characteristics'
    cache_origin_post_quantum_encryption_value:
      type: string
      description: Value of the Origin Post Quantum Encryption Setting.
      enum:
      - preferred
      - supported
      - 'off'
      default: supported
    bot-management_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/bot-management_messages'
        messages:
          $ref: '#/components/schemas/bot-management_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    dns_dns_analytics_api_metrics:
      type: string
      description: A comma-separated list of metrics to query.
      example: queryCount,uncachedCount
    logpush_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    access_policies_components-schemas-single_response-2:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/access_schemas-policies'
    api-shield_api_discovery_state_patch:
      type: string
      description: "Mark state of operation in API Discovery\n  * `review` - Mark operation as for review\n  * `ignored` - Mark operation as ignored\n"
      enum:
      - review
      - ignored
    zones_rocket_loader:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - rocket_loader
            example: rocket_loader
          value:
            $ref: '#/components/schemas/zones_rocket_loader_value'
      title: Rocket Loader
      description: Rocket Loader is a general-purpose asynchronous JavaScript optimisation that prioritises rendering your content while loading your site's Javascript asynchronously. Turning on Rocket Loader will immediately improve a web page's rendering time sometimes measured as Time to First Paint (TTFP), and also the `window.onload` time (assuming there is JavaScript on the page). This can have a positive impact on your Google search ranking. When turned on, Rocket Loader will automatically defer the loading of all Javascript referenced in your HTML, with no configuration required. Refer to [Understanding Rocket Loader](https://support.cloudflare.com/hc/articles/200168056) for more information.
    observatory_url:
      type: string
      description: A URL.
      example: example.com
    api-shield_validation_override_mitigation_action_patch:
      type: string
      description: "When set, this overrides both zone level and operation level mitigation actions.\n\n  - `none` will skip running schema validation entirely for the request\n\nTo clear any override, use the special value `disable_override`\n\n`null` will have no effect.\n"
      enum:
      - none
      - disable_override
      - null
      example: none
      nullable: true
    page-shield_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    legacy-jhs_modified:
      type: string
      format: date-time
      description: When the Application was last modified.
      example: '2014-01-02T02:20:00Z'
      readOnly: true
    dweb-config_description:
      type: string
      description: An optional description of the hostname.
      example: This is my IPFS gateway.
      maxLength: 500
    legacy-jhs_ratelimit_response_collection:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/legacy-jhs_rate-limits'
    dweb-config_content_list_entry_description:
      type: string
      description: An optional description of the content list entry.
      example: this is my content list entry
      maxLength: 500
    dns-records_SSHFPRecord:
      allOf:
      - properties:
          content:
            type: string
            description: Formatted SSHFP content. See 'data' to set SSHFP properties.
            readOnly: true
          data:
            type: object
            description: Components of a SSHFP record.
            properties:
              algorithm:
                type: number
                description: algorithm.
                example: 2
                minimum: 0
                maximum: 255
              fingerprint:
                type: string
                description: fingerprint.
              type:
                type: number
                description: type.
                example: 1
                minimum: 0
                maximum: 255
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - SSHFP
            example: SSHFP
      - $ref: '#/components/schemas/dns-records_base'
      title: SSHFP Record
      required:
      - type
      - name
      - data
    bill-subs-api_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    argo-config_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/argo-config_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/argo-config_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    rulesets_RulesetKind:
      type: string
      title: Kind
      description: The kind of the ruleset.
      enum:
      - managed
      - custom
      - root
      - zone
      example: root
    legacy-jhs_ip_range_search:
      type: string
      description: A single IP address range to search for in existing rules.
      example: 1.2.3.0/16
    healthchecks_consecutive_successes:
      type: integer
      description: The number of consecutive successes required from a health check before changing the health to healthy.
      default: 1
    access_allow_all_headers:
      type: boolean
      description: Allows all HTTP request headers.
      example: true
    access_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    dns_dns_analytics_api_result:
      type: object
      required:
      - rows
      - totals
      - min
      - max
      - data_lag
      - query
      - data
      properties:
        data:
          $ref: '#/components/schemas/dns_dns_analytics_api_data'
        data_lag:
          type: number
          description: Number of seconds between current time and last processed event, in another words how many seconds of data could be missing.
          example: 60
          minimum: 0
        max:
          type: object
          description: Maximum results for each metric (object mapping metric names to values). Currently always an empty object.
        min:
          type: object
          description: Minimum results for each metric (object mapping metric names to values). Currently always an empty object.
        query:
          $ref: '#/components/schemas/dns_dns_analytics_api_query'
        rows:
          type: number
          description: Total number of rows in the result.
          example: 100
          minimum: 0
        totals:
          type: object
          description: Total results for metrics across all data (object mapping metric names to values).
    workers_filters:
      type: object
      required:
      - id
      - pattern
      - enabled
      properties:
        enabled:
          $ref: '#/components/schemas/workers_enabled'
        id:
          $ref: '#/components/schemas/workers_identifier'
        pattern:
          $ref: '#/components/schemas/workers_schemas-pattern'
    email_email_setting_enabled:
      type: boolean
      description: State of the zone settings for Email Routing.
      enum:
      - true
      - false
      default: true
      example: true
    email_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/email_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/email_result_info'
      type: object
    tls-certificates-and-hostnames_location:
      type: string
      description: Location, provided by the CSR
      example: Somewhere
      readOnly: true
    dnssec_public_key:
      type: string
      description: Public key for DS record.
      example: oXiGYrSTO+LSCJ3mohc8EP+CzF9KxBj8/ydXJ22pKuZP3VAC3/Md/k7xZfz470CoRyZJ6gV6vml07IC3d8xqhA==
      nullable: true
      readOnly: true
    rulesets_enabled:
      type: boolean
      description: When true, the Managed Transform is enabled.
      example: true
    dnssec_dnssec_response_single:
      allOf:
      - $ref: '#/components/schemas/dnssec_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/dnssec_dnssec'
    access_groups_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/access_schemas-groups'
    access_schemas-bookmark_props:
      type: object
      title: Bookmark Application
      required:
      - type
      - domain
      properties:
        app_launcher_visible:
          default: true
        domain:
          description: The URL or domain of the bookmark.
          example: https://mybookmark.com
        logo_url:
          $ref: '#/components/schemas/access_logo_url'
        name:
          $ref: '#/components/schemas/access_apps_components-schemas-name'
        type:
          type: string
          description: The application type.
          example: bookmark
    data-zone-analytics-api_dashboard:
      type: object
      title: Dashboard response
      description: Totals and timeseries data.
      properties:
        timeseries:
          $ref: '#/components/schemas/data-zone-analytics-api_timeseries'
        totals:
          $ref: '#/components/schemas/data-zone-analytics-api_totals'
    rulesets_RuleId:
      type: string
      title: ID
      description: The unique ID of the rule.
      example: 3a03d665bac047339bb530ecb439a90d
      pattern: ^[0-9a-f]{32}$
    zones_waf_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    email_email_setting_tag:
      type: string
      description: Email Routing settings tag. (Deprecated, replaced by Email Routing settings identifier)
      example: 75610dab9e69410a82cf7e400a09ecec
      readOnly: true
      deprecated: true
      maxLength: 32
    access_schemas-oidc:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            allOf:
            - $ref: '#/components/schemas/access_generic-oauth-config'
            - type: object
              properties:
                auth_url:
                  type: string
                  description: The authorization_endpoint URL of your IdP
                  example: https://accounts.google.com/o/oauth2/auth
                certs_url:
                  type: string
                  description: The jwks_uri endpoint of your IdP to allow the IdP keys to sign the tokens
                  example: https://www.googleapis.com/oauth2/v3/certs
                claims:
                  type: array
                  description: List of custom claims that will be pulled from your id_token and added to your signed Access JWT token.
                  example:
                  - given_name
                  - locale
                  items:
                    type: string
                scopes:
                  type: array
                  description: OAuth scopes
                  example:
                  - openid
                  - email
                  - profile
                  items:
                    type: string
                token_url:
                  type: string
                  description: The token_endpoint URL of your IdP
                  example: https://accounts.google.com/o/oauth2/token
      type: object
      title: Generic OAuth
    waitingroom_estimated_total_active_users:
      type: integer
    rulesets_RulesetId:
      type: string
      title: ID
      description: The unique ID of the ruleset.
      example: 2f2feab2026849078ba485f918791bdc
      pattern: ^[0-9a-f]{32}$
    healthchecks_id_response:
      allOf:
      - $ref: '#/components/schemas/healthchecks_api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/healthchecks_identifier'
    page-shield_policy_id:
      type: string
      description: The ID of the policy.
      example: c9ef84a6bf5e47138c75d95e2f933e8f
      minLength: 32
      maxLength: 32
    waf-managed-rules_schemas-base:
      allOf:
      - $ref: '#/components/schemas/waf-managed-rules_base'
    legacy-jhs_rule_components-schemas-identifier:
      type: string
      description: The unique identifier of the IP Access rule.
      example: 92f17202ed8bd63d69a66b86a49a8f6b
      readOnly: true
      maxLength: 32
    observatory_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/observatory_api-response-common'
      type: object
    dns_dns_analytics_api_limit:
      type: integer
      description: Limit number of returned metrics.
      default: 100000
      example: 100
    healthchecks_single_response:
      allOf:
      - $ref: '#/components/schemas/healthchecks_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/healthchecks_healthchecks'
    api-shield_operation_feature_parameter_schemas:
      type: object
      readOnly: true
      required:
      - parameter_schemas
      - last_updated
      properties:
        parameter_schemas:
          type: object
          properties:
            last_updated:
              $ref: '#/components/schemas/api-shield_timestamp'
            parameter_schemas:
              $ref: '#/components/schemas/api-shield_parameter_schemas_definition'
    zones_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    cache_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/cache_messages'
        messages:
          $ref: '#/components/schemas/cache_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    dweb-config_collection_response:
      allOf:
      - $ref: '#/components/schemas/dweb-config_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/dweb-config_web3-hostname'
    waitingroom_rules_response_collection:
      allOf:
      - $ref: '#/components/schemas/waitingroom_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/waitingroom_rule_result'
    healthchecks_type:
      type: string
      description: The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'.
      default: HTTP
      example: HTTPS
    logpush_fields:
      type: string
      description: Comma-separated list of fields.
      example: ClientIP,ClientRequestHost,ClientRequestMethod,ClientRequestURI,EdgeEndTimestamp,EdgeResponseBytes,EdgeResponseStatus,EdgeStartTimestamp,RayID
    bot-management_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    zones_prefetch_preload_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    dnssec_ds:
      type: string
      description: Full DS record.
      example: example.com. 3600 IN DS 16953 13 2 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45
      nullable: true
      readOnly: true
    legacy-jhs_rate-limits:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_ratelimit'
      type: object
    zones_nel_value:
      type: object
      description: Value of the zone setting.
      default:
        enabled: false
      properties:
        enabled:
          type: boolean
          default: false
          example: false
    access_schemas-biso_props:
      allOf:
      - $ref: '#/components/schemas/access_schemas-feature_app_props'
      - properties:
          domain:
            example: authdomain.cloudflareaccess.com/browser
            readOnly: true
          name:
            default: Clientless Web Isolation
            example: Clientless Web Isolation
            readOnly: true
          type:
            type: string
            description: The application type.
            example: biso
    api-shield_method:
      type: string
      description: The HTTP method used to access the endpoint.
      enum:
      - GET
      - POST
      - HEAD
      - OPTIONS
      - PUT
      - DELETE
      - CONNECT
      - PATCH
      - TRACE
      example: GET
    cache-purge_Hosts:
      type: object
      properties:
        hosts:
          type: array
          example:
          - www.example.com
          - images.example.com
          items:
            type: string
    email_email_setting_status:
      type: string
      description: Show the state of your account, and the type or configuration error.
      enum:
      - ready
      - unconfigured
      - misconfigured
      - misconfigured/locked
      - unlocked
      example: ready
      readOnly: true
    waitingroom_rule_description:
      type: string
      description: The description of the rule.
      default: ''
      example: allow all traffic from 10.20.30.40
    secondary-dns_schemas-force_result:
      type: string
      description: When force_notify query parameter is set to true, the response is a simple string
      example: OK
    cache_cache_reserve_clear_start_ts:
      type: string
      format: date-time
      description: The time that the latest Cache Reserve Clear operation started.
      example: '2023-10-02T10:00:00.12345Z'
    access_max_age:
      type: number
      description: The maximum number of seconds the results of a preflight request can be cached.
      example: -1
      minimum: -1
      maximum: 86400
    access_enable_binding_cookie:
      type: boolean
      description: Enables the binding cookie, which increases security against compromised authorization tokens and CSRF attacks.
      default: false
    tls-certificates-and-hostnames_ski:
      type: string
      description: Subject Key Identifier
      example: 8e375af1389a069a0f921f8cc8e1eb12d784b949
      readOnly: true
    access_schemas-azureAD:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            allOf:
            - $ref: '#/components/schemas/access_generic-oauth-config'
            - type: object
              properties:
                conditional_access_enabled:
                  type: boolean
                  description: Should Cloudflare try to load authentication contexts from your account
                directory_id:
                  type: string
                  description: Your Azure directory uuid
                  example: <your azure directory uuid>
                prompt:
                  type: string
                  description: Indicates the type of user interaction that is required. prompt=login forces the user to enter their credentials on that request, negating single-sign on. prompt=none is the opposite. It ensures that the user isn't presented with any interactive prompt. If the request can't be completed silently by using single-sign on, the Microsoft identity platform returns an interaction_required error. prompt=select_account interrupts single sign-on providing account selection experience listing all the accounts either in session or any remembered account or an option to choose to use a different account altogether.
                  enum:
                  - login
                  - select_account
                  - none
                support_groups:
                  type: boolean
                  description: Should Cloudflare try to load groups from your account
      type: object
      title: Azure AD
    legacy-jhs_protocol:
      type: string
      description: The port configuration at Cloudflare’s edge. May specify a single port, for example `"tcp/1000"`, or a range of ports, for example `"tcp/1000-2000"`.
      example: tcp/22
    tls-certificates-and-hostnames_components-schemas-expires_on:
      type: string
      format: date-time
      description: When the certificate from the authority expires.
      example: '2100-01-01T05:20:00Z'
      readOnly: true
    tls-certificates-and-hostnames_signature:
      type: string
      description: The type of hash used for the certificate.
      example: SHA256WithRSA
      readOnly: true
    load-balancing_steering_policy:
      type: string
      description: 'Steering Policy for this load balancer.

        - `"off"`: Use `default_pools`.

        - `"geo"`: Use `region_pools`/`country_pools`/`pop_pools`. For non-proxied requests, the country for `country_pools` is determined by `location_strategy`.

        - `"random"`: Select a pool randomly.

        - `"dynamic_latency"`: Use round trip time to select the closest pool in default_pools (requires pool health checks).

        - `"proximity"`: Use the pools'' latitude and longitude to select the closest pool using the Cloudflare PoP location for proxied requests or the location determined by `location_strategy` for non-proxied requests.

        - `"least_outstanding_requests"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool''s number of outstanding requests. Pools with more pending requests are weighted proportionately less relative to others.

        - `"least_connections"`: Select a pool by taking into consideration `random_steering` weights, as well as each pool''s number of open connections. Pools with more open connections are weighted proportionately less relative to others. Supported for HTTP/1 and HTTP/2 connections.

        - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.'
      enum:
      - 'off'
      - geo
      - random
      - dynamic_latency
      - proximity
      - least_outstanding_requests
      - least_connections
      - '""'
      default: '""'
      example: dynamic_latency
    tls-certificates-and-hostnames_custom-hostname:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_customhostname'
      type: object
      required:
      - id
      - hostname
      - ssl
      properties:
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        ssl:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl'
    zone-activation_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    email_rule_catchall-action:
      type: object
      description: Action for the catch-all routing rule.
      required:
      - type
      properties:
        type:
          type: string
          description: Type of action for catch-all rule.
          enum:
          - drop
          - forward
          - worker
          example: forward
        value:
          type: array
          items:
            type: string
            description: Input value for action.
            example: destinationaddress@example.net
            maxLength: 90
    access_apps_components-schemas-single_response-2:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/access_schemas-apps'
    access_app_id:
      oneOf:
      - $ref: '#/components/schemas/access_identifier'
      - $ref: '#/components/schemas/access_uuid'
    cache-purge_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/cache-purge_messages'
        messages:
          $ref: '#/components/schemas/cache-purge_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    custom-pages_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    zones_sha1_support:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: Zone setting identifier.
            enum:
            - sha1_support
            example: sha1_support
          value:
            $ref: '#/components/schemas/zones_sha1_support_value'
      title: Toggle SHA1 support
      description: Allow SHA1 support.
    api-shield_uuid:
      type: string
      format: uuid
      description: UUID identifier
      example: 0d9bf70c-92e1-4bb3-9411-34a3bcc59003
      readOnly: true
      maxLength: 36
    zone-activation_api-response-single:
      allOf:
      - $ref: '#/components/schemas/zone-activation_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    load-balancing_load-balancer_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/load-balancing_load-balancer'
    dweb-config_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/dweb-config_messages'
        messages:
          $ref: '#/components/schemas/dweb-config_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    zones_ip_geolocation:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - ip_geolocation
            example: ip_geolocation
          value:
            $ref: '#/components/schemas/zones_ip_geolocation_value'
      title: IP Geolocation
      description: Enable IP Geolocation to have Cloudflare geolocate visitors to your website and pass the country code to you. (https://support.cloudflare.com/hc/en-us/articles/200168236).
    dns-records_DSRecord:
      allOf:
      - properties:
          content:
            type: string
            description: Formatted DS content. See 'data' to set DS properties.
            readOnly: true
          data:
            type: object
            description: Components of a DS record.
            properties:
              algorithm:
                type: number
                description: Algorithm.
                example: 3
                minimum: 0
                maximum: 255
              digest:
                type: string
                description: Digest.
              digest_type:
                type: number
                description: Digest Type.
                example: 1
                minimum: 0
                maximum: 255
              key_tag:
                type: number
                description: Key Tag.
                example: 1
                minimum: 0
                maximum: 65535
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - DS
            example: DS
      - $ref: '#/components/schemas/dns-records_base'
      title: DS Record
      required:
      - type
      - name
      - data
    waitingroom_event_shuffle_at_event_start:
      type: boolean
      description: If enabled, users in the prequeue will be shuffled randomly at the `event_start_time`. Requires that `prequeue_start_time` is not null. This is useful for situations when many users will join the event prequeue at the same time and you want to shuffle them to ensure fairness. Naturally, it makes the most sense to enable this feature when the `queueing_method` during the event respects ordering such as **fifo**, or else the shuffling may be unnecessary.
      default: false
    page-shield_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/page-shield_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/page-shield_result_info'
      type: object
    waitingroom_search_engine_crawler_bypass:
      type: boolean
      description: 'Whether to allow verified search engine crawlers to bypass all waiting rooms on this zone.

        Verified search engine crawlers will not be tracked or counted by the waiting room system,

        and will not appear in waiting room analytics.

        '
      default: false
      example: true
    api-shield_operation:
      allOf:
      - $ref: '#/components/schemas/api-shield_basic_operation'
      - required:
        - operation_id
        - last_updated
        properties:
          features:
            $ref: '#/components/schemas/api-shield_operation_features'
          last_updated:
            $ref: '#/components/schemas/api-shield_timestamp'
          operation_id:
            $ref: '#/components/schemas/api-shield_uuid'
      type: object
    rulesets_ZoneId:
      type: string
      title: ID
      description: The unique ID of the zone.
      example: 9f1839b6152d298aca64c4e906b6d074
      pattern: ^[0-9a-f]{32}$
    tls-certificates-and-hostnames_schemas-validity_days:
      type: integer
      description: The validity period in days for the certificates ordered via Total TLS.
      enum:
      - 90
    dweb-config_content_list_update_request:
      type: object
      required:
      - action
      - entries
      properties:
        action:
          $ref: '#/components/schemas/dweb-config_content_list_action'
        entries:
          $ref: '#/components/schemas/dweb-config_content_list_entries'
    waf-managed-rules_schemas-identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    load-balancing_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/load-balancing_messages'
        messages:
          $ref: '#/components/schemas/load-balancing_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    dns-custom-nameservers_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/dns-custom-nameservers_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/dns-custom-nameservers_result_info'
      type: object
    legacy-jhs_ssl-recommender_components-schemas-value:
      type: string
      enum:
      - flexible
      - full
      - strict
      example: strict
    zones_waf:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - waf
            example: waf
          value:
            $ref: '#/components/schemas/zones_waf_value'
      title: Web Application Firewall
      description: The WAF examines HTTP requests to your website.  It inspects both GET and POST requests and applies rules to help filter out illegitimate traffic from legitimate website visitors. The Cloudflare WAF inspects website addresses or URLs to detect anything out of the ordinary. If the Cloudflare WAF determines suspicious user behavior, then the WAF will 'challenge' the web visitor with a page that asks them to submit a CAPTCHA successfully  to continue their action. If the challenge is failed, the action will be stopped. What this means is that Cloudflare's WAF will block any traffic identified as illegitimate before it reaches your origin web server. (https://support.cloudflare.com/hc/en-us/articles/200172016).
    email_rule_matcher:
      type: object
      description: Matching pattern to forward your actions.
      required:
      - type
      - field
      - value
      properties:
        field:
          type: string
          description: Field for type matcher.
          enum:
          - to
          example: to
        type:
          type: string
          description: Type of matcher.
          enum:
          - literal
          example: literal
        value:
          type: string
          description: Value for matcher.
          example: test@example.com
          maxLength: 90
    page-shield_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/page-shield_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/page-shield_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    waf-managed-rules_description:
      type: string
      description: An informative summary of what the rule group does.
      example: Group designed to protect against IP addresses that are a threat and typically used to launch DDoS attacks
      nullable: true
      readOnly: true
    tls-certificates-and-hostnames_keyless_vnet_id:
      type: string
      description: Cloudflare Tunnel Virtual Network ID
      example: 7365377a-85a4-4390-9480-531ef7dc7a3c
    zaraz_zaraz-workflow:
      type: string
      description: Zaraz workflow
      enum:
      - realtime
      - preview
    tls-certificates-and-hostnames_client_certificate:
      properties:
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_client-certificates_components-schemas-certificate'
        certificate_authority:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_client-certificates_components-schemas-certificate_authority'
        common_name:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_common_name'
        country:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_country'
        csr:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-csr'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_expired_on'
        fingerprint_sha256:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_fingerprint_sha256'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        issued_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_issued_on'
        location:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_location'
        organization:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_organization'
        organizational_unit:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_organizational_unit'
        serial_number:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-serial_number'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-signature'
        ski:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_ski'
        state:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_state'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_client-certificates_components-schemas-status'
        validity_days:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-validity_days'
    tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-status:
      description: Status of the certificate activation.
      enum:
      - initializing
      - pending_deployment
      - pending_deletion
      - active
      - deleted
      - deployment_timed_out
      - deletion_timed_out
      example: active
    waitingroom_event_queueing_method:
      type: string
      description: If set, the event will override the waiting room's `queueing_method` property while it is active. If null, the event will inherit it.
      example: random
      nullable: true
    secondary-dns_name:
      type: string
      description: Zone name.
      example: www.example.com.
    dweb-config_content_list_entry:
      type: object
      description: Content list entry to be blocked.
      properties:
        content:
          $ref: '#/components/schemas/dweb-config_content_list_entry_content'
        created_on:
          $ref: '#/components/schemas/dweb-config_timestamp'
        description:
          $ref: '#/components/schemas/dweb-config_content_list_entry_description'
        id:
          $ref: '#/components/schemas/dweb-config_identifier'
        modified_on:
          $ref: '#/components/schemas/dweb-config_timestamp'
        type:
          $ref: '#/components/schemas/dweb-config_content_list_entry_type'
    argo-config_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/argo-config_messages'
        messages:
          $ref: '#/components/schemas/argo-config_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    tls-certificates-and-hostnames_enabled_response:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            properties:
              enabled:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled'
    tls-certificates-and-hostnames_certificateObject:
      properties:
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-expires_on'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        issuer:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_issuer'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_signature'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-status'
        uploaded_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-uploaded_on'
    waitingroom_event_prequeue_start_time:
      type: string
      description: An ISO 8601 timestamp that marks when to begin queueing all users before the event starts. The prequeue must start at least five minutes before `event_start_time`.
      example: '2021-09-28T15:00:00.000Z'
      nullable: true
    workers_schemas-pattern:
      type: string
      title: Filter pattern
      example: example.net/*
    speed_cloudflare_fonts:
      allOf:
      - $ref: '#/components/schemas/speed_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - fonts
            example: fonts
          value:
            $ref: '#/components/schemas/speed_cloudflare_fonts_value'
      title: Cloudflare Fonts
      description: 'Enhance your website''s font delivery with Cloudflare Fonts. Deliver Google Hosted fonts from your own domain,

        boost performance, and enhance user privacy. Refer to the Cloudflare Fonts documentation for more information.

        '
    access_okta_group_rule:
      type: object
      title: Okta group
      description: 'Matches an Okta group.

        Requires an Okta identity provider.'
      required:
      - okta
      properties:
        okta:
          type: object
          required:
          - email
          - connection_id
          properties:
            connection_id:
              type: string
              description: The ID of your Okta identity provider.
              example: ea85612a-29c8-46c2-bacb-669d65136971
            email:
              type: string
              description: The email of the Okta group.
              example: devs@cloudflare.com
    tls-certificates-and-hostnames_custom_origin_sni:
      type: string
      description: A hostname that will be sent to your custom origin server as SNI for TLS handshake. This can be a valid subdomain of the zone or custom origin server name or the string ':request_host_header:' which will cause the host header in the request to be used as SNI. Not configurable with default/fallback origin server.
      example: sni.example.com
    legacy-jhs_schemas-url:
      type: string
      description: The URL pattern to match, composed of a host and a path such as `example.org/path*`. Normalization is applied before the pattern is matched. `*` wildcards are expanded to match applicable traffic. Query strings are not matched. Set the value to `*` to match all traffic to your zone.
      example: '*.example.org/path*'
      maxLength: 1024
    argo-config_value:
      type: string
      description: Enables Argo Smart Routing.
      enum:
      - 'on'
      - 'off'
      example: 'on'
    logpush_sample:
      type: integer
      description: 'The sample parameter is the sample rate of the records set by the client: "sample": 1 is 100% of records "sample": 10 is 10% and so on.'
      example: 1
    data-zone-analytics-api_sample:
      type: number
      description: 'When `?sample=` is provided, a sample of matching records is returned. If `sample=0.1` then 10% of records will be returned. Sampling is random: repeated calls will not only return different records, but likely will also vary slightly in number of returned records. When `?count=` is also specified, `count` is applied to the number of returned records, not the sampled records. So, with `sample=0.05` and `count=7`, when there is a total of 100 records available, approximately five will be returned. When there are 1000 records, seven will be returned. When there are 10,000 records, seven will be returned.'
      example: 0.1
      minimum: 0
      maximum: 1
    page-shield_pageshield-policy-expression:
      type: string
      description: The expression which must match for the policy to be applied, using the Cloudflare Firewall rule expression syntax
      example: ends_with(http.request.uri.path, "/checkout")
    legacy-jhs_rule_single_response:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/legacy-jhs_rule'
    zones_webp:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - webp
            example: webp
          value:
            $ref: '#/components/schemas/zones_webp_value'
      title: Polish WebP Conversion
      description: When the client requesting the image supports the WebP image codec, and WebP offers a performance advantage over the original image format, Cloudflare will serve a WebP version of the original image.
    rulesets_ExecuteRule:
      allOf:
      - $ref: '#/components/schemas/rulesets_Rule'
      - title: Execute rule
        properties:
          action:
            enum:
            - execute
          action_parameters:
            required:
            - id
            properties:
              id:
                allOf:
                - $ref: '#/components/schemas/rulesets_RulesetId'
                - description: The ID of the ruleset to execute.
                  example: 4814384a9e5d4991b9815dcfc25d2f1f
              matched_data:
                type: object
                title: Matched data
                description: The configuration to use for matched data logging.
                required:
                - public_key
                properties:
                  public_key:
                    type: string
                    title: Public key
                    description: The public key to encrypt matched data logs with.
                    example: iGqBmyIUxuWt1rvxoAharN9FUXneUBxA/Y19PyyrEG0=
                    minLength: 1
              overrides:
                type: object
                title: Overrides
                description: A set of overrides to apply to the target ruleset.
                properties:
                  action:
                    allOf:
                    - $ref: '#/components/schemas/rulesets_RuleAction'
                    - description: An action to override all rules with. This option has lower precedence than rule and category overrides.
                  categories:
                    type: array
                    title: Category overrides
                    description: A list of category-level overrides. This option has the second-highest precedence after rule-level overrides.
                    uniqueItems: true
                    minItems: 1
                    items:
                      type: object
                      title: Category override
                      description: A category-level override
                      required:
                      - category
                      properties:
                        action:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_RuleAction'
                          - description: The action to override rules in the category with.
                        category:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_RuleCategory'
                          - description: The name of the category to override.
                        enabled:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_RuleEnabled'
                          - description: Whether to enable execution of rules in the category.
                        sensitivity_level:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel'
                          - description: The sensitivity level to use for rules in the category.
                      minProperties: 2
                  enabled:
                    allOf:
                    - $ref: '#/components/schemas/rulesets_RuleEnabled'
                    - description: Whether to enable execution of all rules. This option has lower precedence than rule and category overrides.
                  rules:
                    type: array
                    title: Rule overrides
                    description: A list of rule-level overrides. This option has the highest precedence.
                    uniqueItems: true
                    minItems: 1
                    items:
                      type: object
                      title: Rule override
                      description: A rule-level override
                      required:
                      - id
                      properties:
                        action:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_RuleAction'
                          - description: The action to override the rule with.
                        enabled:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_RuleEnabled'
                          - description: Whether to enable execution of the rule.
                        id:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_RuleId'
                          - description: The ID of the rule to override.
                            example: 8ac8bc2a661e475d940980f9317f28e1
                        score_threshold:
                          type: integer
                          title: Score threshold
                          description: The score threshold to use for the rule.
                        sensitivity_level:
                          allOf:
                          - $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel'
                          - description: The sensitivity level to use for the rule.
                      minProperties: 2
                  sensitivity_level:
                    allOf:
                    - $ref: '#/components/schemas/rulesets_ExecuteSensitivityLevel'
                    - description: A sensitivity level to set for all rules. This option has lower precedence than rule and category overrides and is only applicable for DDoS phases.
                minProperties: 1
          description:
            example: Execute the OWASP ruleset when the IP address is not 1.1.1.1
    custom-pages_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    rulesets_RulesetVersion:
      type: string
      title: Version
      description: The version of the ruleset.
      example: '1'
      readOnly: true
      pattern: ^[0-9]+$
    cache_origin_max_http_version:
      allOf:
      - $ref: '#/components/schemas/cache_base'
      - properties:
          id:
            description: Value of the zone setting.
            enum:
            - origin_max_http_version
            example: origin_max_http_version
      title: Origin Max HTTP Version
      description: Origin Max HTTP Setting Version sets the highest HTTP version Cloudflare will attempt to use with your origin. This setting allows Cloudflare to make HTTP/2 requests to your origin. (Refer to [Enable HTTP/2 to Origin](https://developers.cloudflare.com/cache/how-to/enable-http2-to-origin/), for more information.). The default value is "2" for all plan types except ENT where it is "1"
    waitingroom_schemas-api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/waitingroom_messages'
        messages:
          $ref: '#/components/schemas/waitingroom_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    tls-certificates-and-hostnames_ssl_validation_method_response_collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            properties:
              status:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_method_components-schemas-status'
              validation_method:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_method_definition'
    zones_minify:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: Zone setting identifier.
            enum:
            - minify
            example: minify
          value:
            $ref: '#/components/schemas/zones_minify_value'
      title: Auto-Minify Assets
      description: Automatically minify certain assets for your website. Refer to [Using Cloudflare Auto Minify](https://support.cloudflare.com/hc/en-us/articles/200168196) for more information.
    page-shield_script:
      properties:
        added_at:
          example: '2021-08-18T10:51:10.09615Z'
        domain_reported_malicious:
          example: false
        fetched_at:
          example: '2021-09-02T10:17:54Z'
        first_page_url:
          example: blog.cloudflare.com/page
        first_seen_at:
          example: '2021-08-18T10:51:08Z'
        hash:
          example: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855
        host:
          example: blog.cloudflare.com
        id:
          example: c9ef84a6bf5e47138c75d95e2f933e8f
        js_integrity_score:
          example: 10
        last_seen_at:
          example: '2021-09-02T09:57:54Z'
        page_urls:
          example:
          - blog.cloudflare.com/page1
          - blog.cloudflare.com/page2
        url:
          example: https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js
        url_contains_cdn_cgi_path:
          example: false
    zones_tls_1_2_only_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'off'
      - 'on'
      default: 'off'
    observatory_create-schedule-response:
      allOf:
      - $ref: '#/components/schemas/observatory_api-response-single'
      - properties:
          result:
            type: object
            properties:
              schedule:
                $ref: '#/components/schemas/observatory_schedule'
              test:
                $ref: '#/components/schemas/observatory_page_test'
    zones_schemas-automatic_platform_optimization:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - automatic_platform_optimization
            example: automatic_platform_optimization
          value:
            $ref: '#/components/schemas/zones_automatic_platform_optimization'
      title: Automatic Platform Optimization for WordPress
      description: '[Automatic Platform Optimization for WordPress](https://developers.cloudflare.com/automatic-platform-optimization/) serves your WordPress site from Cloudflare''s edge network and caches third-party fonts.'
    cache_schemas-patch:
      type: object
      description: Update enablement of Smart Tiered Cache
      required:
      - value
      properties:
        value:
          $ref: '#/components/schemas/cache_schemas-value'
    zones_string_constraint:
      type: object
      description: String constraint.
      required:
      - operator
      - value
      properties:
        operator:
          description: The matches operator can use asterisks and pipes as wildcard and 'or' operators.
          enum:
          - matches
          - contains
          - equals
          - not_equal
          - not_contain
          default: contains
        value:
          type: string
          description: The value to apply the operator to.
    legacy-jhs_package_definition:
      title: Traditional WAF package
      required:
      - id
      - name
      - description
      - detection_mode
      - zone_id
      properties:
        description:
          $ref: '#/components/schemas/legacy-jhs_package_components-schemas-description'
        detection_mode:
          $ref: '#/components/schemas/legacy-jhs_detection_mode'
        id:
          $ref: '#/components/schemas/legacy-jhs_package_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/legacy-jhs_package_components-schemas-name'
        status:
          $ref: '#/components/schemas/legacy-jhs_package_components-schemas-status'
        zone_id:
          $ref: '#/components/schemas/legacy-jhs_common_components-schemas-identifier'
    legacy-jhs_dns_ttl:
      type: integer
      description: The TTL of our resolution of your DNS record in seconds.
      minimum: 600
    access_service-tokens_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/access_service-tokens'
    api-shield_api_discovery_patch_multiple_request:
      type: object
      example:
        3818d821-5901-4147-a474-f5f5aec1d54e:
          state: ignored
        b17c8043-99a0-4202-b7d9-8f7cdbee02cd:
          state: review
    zaraz_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    tls-certificates-and-hostnames_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_result_info'
      type: object
    api-shield_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/api-shield_messages'
        messages:
          $ref: '#/components/schemas/api-shield_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          example: true
    tls-certificates-and-hostnames_name:
      type: string
      description: The keyless SSL name.
      example: example.com Keyless SSL
      readOnly: true
      maxLength: 180
    waitingroom_disable_session_renewal:
      type: boolean
      description: Only available for the Waiting Room Advanced subscription. Disables automatic renewal of session cookies. If `true`, an accepted user will have session_duration minutes to browse the site. After that, they will have to go through the waiting room again. If `false`, a user's session cookie will be automatically renewed on every request.
      default: false
      example: false
    zones_0rtt:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - 0rtt
            example: 0rtt
          value:
            $ref: '#/components/schemas/zones_0rtt_value'
      title: 0-RTT Value
      description: 0-RTT session resumption enabled for this zone.
    zaraz_zaraz-config-body:
      allOf:
      - $ref: '#/components/schemas/zaraz_zaraz-config-base'
      - properties:
          tools:
            type: object
            description: Tools set up under Zaraz configuration, where key is the alpha-numeric tool ID and value is the tool configuration object.
    healthchecks_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/healthchecks_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/healthchecks_result_info'
      type: object
    legacy-jhs_filter-rule-base:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/legacy-jhs_components-schemas-action'
        description:
          $ref: '#/components/schemas/legacy-jhs_firewall-rules_components-schemas-description'
        id:
          $ref: '#/components/schemas/legacy-jhs_firewall-rules_components-schemas-id'
        paused:
          $ref: '#/components/schemas/legacy-jhs_components-schemas-paused'
        priority:
          $ref: '#/components/schemas/legacy-jhs_firewall-rules_components-schemas-priority'
        products:
          $ref: '#/components/schemas/legacy-jhs_products'
        ref:
          $ref: '#/components/schemas/legacy-jhs_ref'
    tls-certificates-and-hostnames_certificate_pack_quota_response:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - type: object
        properties:
          result:
            type: object
            properties:
              advanced:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_quota'
    access_country_rule:
      type: object
      title: Country
      description: Matches a specific country
      required:
      - geo
      properties:
        geo:
          type: object
          required:
          - country_code
          properties:
            country_code:
              type: string
              description: The country code that should be matched.
              example: US
    api-shield_zone_schema_validation_settings_put:
      type: object
      required:
      - validation_default_mitigation_action
      properties:
        validation_default_mitigation_action:
          $ref: '#/components/schemas/api-shield_validation_default_mitigation_action'
        validation_override_mitigation_action:
          $ref: '#/components/schemas/api-shield_validation_override_mitigation_action_write'
    page-shield_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/page-shield_messages'
        messages:
          $ref: '#/components/schemas/page-shield_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    data-zone-analytics-api_requests:
      type: object
      description: Breakdown of totals for requests.
      properties:
        all:
          type: integer
          description: Total number of requests served.
        cached:
          type: integer
          description: Total number of cached requests served.
        content_type:
          type: object
          description: A variable list of key/value pairs where the key represents the type of content served, and the value is the number of requests.
          example:
            css: 15343
            gif: 23178
            html: 1234213
            javascript: 318236
            jpeg: 1982048
        country:
          type: object
          description: A variable list of key/value pairs where the key is a two-digit country code and the value is the number of requests served to that country.
          example:
            AG: 37298
            GI: 293846
            US: 4181364
        http_status:
          type: object
          description: Key/value pairs where the key is a HTTP status code and the value is the number of requests served with that code.
          example:
            '200': 13496983
            '301': 283
            '400': 187936
            '402': 1828
            '404': 1293
        ssl:
          type: object
          description: A break down of requests served over HTTPS.
          properties:
            encrypted:
              type: integer
              description: The number of requests served over HTTPS.
            unencrypted:
              type: integer
              description: The number of requests served over HTTP.
        ssl_protocols:
          type: object
          description: A breakdown of requests by their SSL protocol.
          properties:
            TLSv1:
              type: integer
              description: The number of requests served over TLS v1.0.
            TLSv1.1:
              type: integer
              description: The number of requests served over TLS v1.1.
            TLSv1.2:
              type: integer
              description: The number of requests served over TLS v1.2.
            TLSv1.3:
              type: integer
              description: The number of requests served over TLS v1.3.
            none:
              type: integer
              description: The number of requests served over HTTP.
        uncached:
          type: integer
          description: Total number of requests served from the origin.
    access_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    email_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    legacy-jhs_package_response_collection:
      anyOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/legacy-jhs_package'
    bill-subs-api_rate_plan:
      type: object
      description: The rate plan applied to the subscription.
      properties:
        currency:
          type: string
          description: The currency applied to the rate plan subscription.
          example: USD
        externally_managed:
          type: boolean
          description: Whether this rate plan is managed externally from Cloudflare.
          example: false
        id:
          description: The ID of the rate plan.
          example: free
        is_contract:
          type: boolean
          description: Whether a rate plan is enterprise-based (or newly adopted term contract).
          example: false
        public_name:
          type: string
          description: The full name of the rate plan.
          example: Business Plan
        scope:
          type: string
          description: The scope that this rate plan applies to.
          example: zone
        sets:
          type: array
          description: The list of sets this rate plan applies to.
          items:
            type: string
    healthchecks_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/healthchecks_messages'
        messages:
          $ref: '#/components/schemas/healthchecks_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    zones_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      properties:
        errors:
          $ref: '#/components/schemas/zones_messages'
        messages:
          $ref: '#/components/schemas/zones_messages'
        success:
          type: boolean
          description: Whether the API call was successful
          example: true
    logpush_validate_response:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            properties:
              message:
                type: string
                example: ''
              valid:
                type: boolean
                example: true
    zones_security_level_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'off'
      - essentially_off
      - low
      - medium
      - high
      - under_attack
      default: medium
    cache-purge_UrlAndHeaders:
      type: object
      properties:
        headers:
          type: object
          example: "{\n    \"Origin\": \"https://www.cloudflare.com\",\n    \"CF-IPCountry\": \"US\",\n    \"CF-Device-Type\": \"desktop\",\n    \"Accept-Language\": \"zh-CN\"\n}"
        url:
          type: string
          example: http://www.example.com/cat_picture.jpg
    legacy-jhs_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/legacy-jhs_result_info'
      type: object
    bot-management_api-response-single:
      allOf:
      - $ref: '#/components/schemas/bot-management_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    dns-records_tag_match:
      type: string
      description: 'Whether to match all tag search requirements or at least one (any). If set to `all`, acts like a logical AND between tag filters. If set to `any`, acts like a logical OR instead. Note that the regular `match` parameter is still used to combine the resulting condition with other filters that aren''t related to tags.

        '
      enum:
      - any
      - all
      default: all
      example: any
    secondary-dns_single_response_incoming:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-single'
      - properties:
          result:
            type: object
            properties:
              auto_refresh_seconds:
                $ref: '#/components/schemas/secondary-dns_auto_refresh_seconds'
              checked_time:
                $ref: '#/components/schemas/secondary-dns_time'
              created_time:
                $ref: '#/components/schemas/secondary-dns_time'
              id:
                $ref: '#/components/schemas/secondary-dns_identifier'
              modified_time:
                $ref: '#/components/schemas/secondary-dns_time'
              name:
                $ref: '#/components/schemas/secondary-dns_name'
              peers:
                $ref: '#/components/schemas/secondary-dns_peers'
              soa_serial:
                $ref: '#/components/schemas/secondary-dns_soa_serial'
    tls-certificates-and-hostnames_components-schemas-signature:
      type: string
      description: The type of hash used for the Client Certificate..
      example: SHA256WithRSA
      readOnly: true
    tls-certificates-and-hostnames_enabled_write:
      type: boolean
      description: Whether or not the Keyless SSL is on or off.
      example: false
      deprecated: true
    custom-pages_state:
      type: string
      description: The custom page state.
      enum:
      - default
      - customized
      example: default
    tls-certificates-and-hostnames_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
        messages:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    access_cors_headers:
      type: object
      properties:
        allow_all_headers:
          $ref: '#/components/schemas/access_allow_all_headers'
        allow_all_methods:
          $ref: '#/components/schemas/access_allow_all_methods'
        allow_all_origins:
          $ref: '#/components/schemas/access_allow_all_origins'
        allow_credentials:
          $ref: '#/components/schemas/access_allow_credentials'
        allowed_headers:
          $ref: '#/components/schemas/access_allowed_headers'
        allowed_methods:
          $ref: '#/components/schemas/access_allowed_methods'
        allowed_origins:
          $ref: '#/components/schemas/access_allowed_origins'
        max_age:
          $ref: '#/components/schemas/access_max_age'
    access_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/access_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/access_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    zones_0rtt_value:
      type: string
      description: Value of the 0-RTT setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    waitingroom_waiting_room_id_response:
      allOf:
      - $ref: '#/components/schemas/waitingroom_api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/waitingroom_waiting_room_id'
    waitingroom_preview_response:
      allOf:
      - $ref: '#/components/schemas/waitingroom_api-response-single'
      - properties:
          result:
            type: object
            properties:
              preview_url:
                $ref: '#/components/schemas/waitingroom_preview_url'
    snippets-api_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/snippets-api_messages'
        messages:
          $ref: '#/components/schemas/snippets-api_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    tls-certificates-and-hostnames_issuer:
      type: string
      description: The certificate authority that issued the certificate.
      example: GlobalSign
      readOnly: true
    zones_cname_flattening_value:
      type: string
      description: Value of the cname flattening setting.
      enum:
      - flatten_at_root
      - flatten_all
      default: flatten_at_root
    tls-certificates-and-hostnames_validation_method:
      type: string
      description: Validation Method selected for the order.
      enum:
      - txt
      - http
      - email
      example: txt
    tls-certificates-and-hostnames_setting_id:
      type: string
      description: The TLS Setting name.
      enum:
      - ciphers
      - min_tls_version
      - http2
    secondary-dns_force_response:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/secondary-dns_force_result'
    data-zone-analytics-api_flag_response:
      allOf:
      - $ref: '#/components/schemas/data-zone-analytics-api_api-response-single'
      - properties:
          result:
            type: object
            properties:
              flag:
                type: boolean
                example: true
    access_schemas-empty_response:
      allOf:
      - properties:
          result:
            type: object
            nullable: true
          success:
            type: boolean
            enum:
            - true
            - false
            example: true
    access_allow_all_methods:
      type: boolean
      description: Allows all HTTP request methods.
    argo-analytics_api-response-single:
      allOf:
      - $ref: '#/components/schemas/argo-analytics_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
              nullable: true
            - type: string
              nullable: true
      type: object
    waitingroom_suspended:
      type: boolean
      description: Suspends or allows traffic going to the waiting room. If set to `true`, the traffic will not go to the waiting room.
      default: false
    access_app_launcher_visible:
      type: boolean
      description: Displays the application in the App Launcher.
      default: true
      example: true
    workers_schemas-script-response-single:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-single'
      - properties:
          result:
            type: object
    bill-subs-api_legacy_id:
      type: string
      description: The legacy identifier for this rate plan, if any.
      example: free
      readOnly: true
    waf-managed-rules_identifier:
      type: string
      description: The unique identifier of a WAF package.
      example: a25a9a7e9c00afc1fb2e0245519d725b
      readOnly: true
      maxLength: 32
    legacy-jhs_firewalluablock_response_collection:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/legacy-jhs_ua-rules'
    dweb-config_content_list_entry_single_response:
      allOf:
      - $ref: '#/components/schemas/dweb-config_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/dweb-config_content_list_entry'
    legacy-jhs_ua-rules:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_firewalluablock'
      type: object
    legacy-jhs_lockdowns_components-schemas-id:
      type: string
      description: The unique identifier of the Zone Lockdown rule.
      example: 372e67954025e0ba6aaa6d586b9e0b59
      readOnly: true
      maxLength: 32
    tls-certificates-and-hostnames_ownership_verification:
      oneOf:
      - type: object
        properties:
          name:
            type: string
            description: DNS Name for record.
            example: _cf-custom-hostname.app.example.com
          type:
            description: DNS Record type.
            enum:
            - txt
            example: txt
          value:
            type: string
            description: Content for the record.
            example: 5cc07c04-ea62-4a5a-95f0-419334a875a4
      type: object
      description: This is a record which can be placed to activate a hostname.
    custom-pages_custom_pages_response_collection:
      allOf:
      - $ref: '#/components/schemas/custom-pages_api-response-collection'
      - properties:
          result:
            type: array
            items:
              type: object
    waf-managed-rules_rule_group_response_collection:
      allOf:
      - $ref: '#/components/schemas/waf-managed-rules_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/waf-managed-rules_schemas-group'
    access_oidc_saas_app:
      type: object
      title: OIDC SaaS App
      properties:
        app_launcher_url:
          type: string
          description: The URL where this applications tile redirects users
          example: https://example.com/login
        auth_type:
          type: string
          description: Identifier of the authentication protocol used for the saas app. Required for OIDC.
          enum:
          - saml
          - oidc
          example: oidc
        client_id:
          type: string
          description: The application client id
          example: oidc client id
        client_secret:
          type: string
          description: The application client secret, only returned on POST request.
          example: oidc client secret
        created_at:
          $ref: '#/components/schemas/access_timestamp'
        grant_types:
          type: array
          description: The OIDC flows supported by this application
          example:
          - authorization_code
          items:
            type: string
            enum:
            - authorization_code
            - authorization_code_with_pkce
        group_filter_regex:
          type: string
          description: A regex to filter Cloudflare groups returned in ID token and userinfo endpoint
          example: ^GROUP_FILTER-*$
        public_key:
          type: string
          description: The Access public certificate that will be used to verify your identity.
          example: example unique name
        redirect_uris:
          type: array
          description: The permitted URL's for Cloudflare to return Authorization codes and Access/ID tokens
          example:
          - https://example.com
          items:
            type: string
        scopes:
          type: array
          description: Define the user information shared with access
          example:
          - openid
          - groups
          - email
          - profile
          items:
            type: string
            enum:
            - openid
            - groups
            - email
            - profile
        updated_at:
          $ref: '#/components/schemas/access_timestamp'
    dns-records_TLSARecord:
      allOf:
      - properties:
          content:
            type: string
            description: Formatted TLSA content. See 'data' to set TLSA properties.
            readOnly: true
          data:
            type: object
            description: Components of a TLSA record.
            properties:
              certificate:
                type: string
                description: certificate.
              matching_type:
                type: number
                description: Matching Type.
                example: 1
                minimum: 0
                maximum: 255
              selector:
                type: number
                description: Selector.
                example: 0
                minimum: 0
                maximum: 255
              usage:
                type: number
                description: Usage.
                example: 0
                minimum: 0
                maximum: 255
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - TLSA
            example: TLSA
      - $ref: '#/components/schemas/dns-records_base'
      title: TLSA Record
      required:
      - type
      - name
      - data
    waitingroom_default_template_language:
      type: string
      description: The language of the default page template. If no default_template_language is provided, then `en-US` (English) will be used.
      enum:
      - en-US
      - es-ES
      - de-DE
      - fr-FR
      - it-IT
      - ja-JP
      - ko-KR
      - pt-BR
      - zh-CN
      - zh-TW
      - nl-NL
      - pl-PL
      - id-ID
      - tr-TR
      - ar-EG
      - ru-RU
      - fa-IR
      default: en-US
      example: es-ES
    bill-subs-api_plan_response_collection:
      allOf:
      - $ref: '#/components/schemas/bill-subs-api_api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/bill-subs-api_schemas-rate-plan'
    tls-certificates-and-hostnames_port:
      type: number
      description: The keyless SSL port used to communicate between Cloudflare and the client's Keyless SSL server.
      default: 24008
      example: 24008
      maxLength: 65535
    logpush_logpush_job:
      type: object
      nullable: true
      properties:
        dataset:
          $ref: '#/components/schemas/logpush_dataset'
        destination_conf:
          $ref: '#/components/schemas/logpush_destination_conf'
        enabled:
          $ref: '#/components/schemas/logpush_enabled'
        error_message:
          $ref: '#/components/schemas/logpush_error_message'
        frequency:
          $ref: '#/components/schemas/logpush_frequency'
        id:
          $ref: '#/components/schemas/logpush_id'
        last_complete:
          $ref: '#/components/schemas/logpush_last_complete'
        last_error:
          $ref: '#/components/schemas/logpush_last_error'
        logpull_options:
          $ref: '#/components/schemas/logpush_logpull_options'
        name:
          $ref: '#/components/schemas/logpush_name'
        output_options:
          $ref: '#/components/schemas/logpush_output_options'
    access_certificates_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/access_certificates'
    snippets-api_rules:
      type: array
      description: List of snippet rules
      items:
        type: object
        properties:
          description:
            type: string
            example: Rule description
          enabled:
            type: boolean
            example: true
          expression:
            type: string
            example: http.cookie eq "a=b"
          snippet_name:
            $ref: '#/components/schemas/snippets-api_snippet_name'
    waf-managed-rules_traditional_deny_rule:
      allOf:
      - $ref: '#/components/schemas/waf-managed-rules_base'
      - properties:
          allowed_modes:
            $ref: '#/components/schemas/waf-managed-rules_allowed_modes_deny_traditional'
          default_mode:
            $ref: '#/components/schemas/waf-managed-rules_default_mode'
          mode:
            $ref: '#/components/schemas/waf-managed-rules_mode_deny_traditional'
      title: Traditional (deny) WAF rule
      description: When triggered, traditional WAF rules cause the firewall to immediately act upon the request based on the configuration of the rule. A 'deny' rule will immediately respond to the request based on the configured rule action/mode (for example, 'block') and no other rules will be processed.
      required:
      - id
      - description
      - priority
      - allowed_modes
      - default_mode
      - mode
      - group
      - package_id
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_certid_object'
      type: object
      properties:
        cert_id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate'
        enabled:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled'
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostname'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        private_key:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-private_key'
    cache-purge_api-response-single-id:
      allOf:
      - $ref: '#/components/schemas/cache-purge_api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            required:
            - id
            properties:
              id:
                $ref: '#/components/schemas/cache-purge_schemas-identifier'
      type: object
    tls-certificates-and-hostnames_sslsettings:
      type: object
      description: SSL specific settings.
      properties:
        ciphers:
          type: array
          description: An allowlist of ciphers for TLS termination. These ciphers must be in the BoringSSL format.
          example:
          - ECDHE-RSA-AES128-GCM-SHA256
          - AES128-SHA
          uniqueItems: true
          items:
            type: string
        early_hints:
          description: Whether or not Early Hints is enabled.
          enum:
          - 'on'
          - 'off'
          example: 'on'
        http2:
          description: Whether or not HTTP2 is enabled.
          enum:
          - 'on'
          - 'off'
          example: 'on'
        min_tls_version:
          description: The minimum TLS version supported.
          enum:
          - '1.0'
          - '1.1'
          - '1.2'
          - '1.3'
          example: '1.2'
        tls_1_3:
          description: Whether or not TLS 1.3 is enabled.
          enum:
          - 'on'
          - 'off'
          example: 'on'
    zones_schemas-api-response-single-id:
      allOf:
      - $ref: '#/components/schemas/zones_schemas-api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            required:
            - id
            properties:
              id:
                $ref: '#/components/schemas/zones_schemas-identifier'
      type: object
    access_schemas-github:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            $ref: '#/components/schemas/access_generic-oauth-config'
      type: object
      title: GitHub
    zone-activation_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/zone-activation_messages'
        messages:
          $ref: '#/components/schemas/zone-activation_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    load-balancing_timestamp:
      type: string
      format: date-time
      example: '2014-01-01T05:20:00.12345Z'
      readOnly: true
    email_dns_record:
      type: object
      description: List of records needed to enable an Email Routing zone.
      properties:
        content:
          type: string
          description: DNS record content.
          example: route1.mx.cloudflare.net
        name:
          type: string
          description: DNS record name (or @ for the zone apex).
          example: example.com
          maxLength: 255
        priority:
          type: number
          description: Required for MX, SRV and URI records. Unused by other record types. Records with lower priorities are preferred.
          example: 12
          minimum: 0
          maximum: 65535
        ttl:
          anyOf:
          - type: number
            example: 3600
            minimum: 1
            maximum: 86400
          - type: number
            enum:
            - 1
          type: number
          description: Time to live, in seconds, of the DNS record. Must be between 60 and 86400, or 1 for 'automatic'.
          example: 1
        type:
          type: string
          description: DNS record type.
          enum:
          - A
          - AAAA
          - CNAME
          - HTTPS
          - TXT
          - SRV
          - LOC
          - MX
          - NS
          - CERT
          - DNSKEY
          - DS
          - NAPTR
          - SMIMEA
          - SSHFP
          - SVCB
          - TLSA
          - URI
          example: NS
          readOnly: true
    access_azure_group_rule:
      type: object
      title: Azure group
      description: 'Matches an Azure group.

        Requires an Azure identity provider.'
      required:
      - azureAD
      properties:
        azureAD:
          type: object
          required:
          - id
          - connection_id
          properties:
            connection_id:
              type: string
              description: The ID of your Azure identity provider.
              example: ea85612a-29c8-46c2-bacb-669d65136971
            id:
              type: string
              description: The ID of an Azure group.
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
    waitingroom_next_event_start_time:
      type: string
      description: An ISO 8601 timestamp that marks when the next event will start.
      example: '2021-09-28T15:00:00.000Z'
      nullable: true
    secondary-dns_peers:
      type: array
      description: A list of peer tags.
      example:
      - 23ff594956f20c2a721606e94745a8aa
      - 00920f38ce07c2e2f4df50b1f61d4194
      items: {}
    argo-analytics_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    access_client_id:
      type: string
      description: The Client ID for the service token. Access will check for this value in the `CF-Access-Client-ID` request header.
      example: 88bf3b6d86161464f6509f7219099e57.access.example.com
    cache_api-response-single:
      allOf:
      - $ref: '#/components/schemas/cache_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
              nullable: true
            - type: string
              nullable: true
      type: object
    tls-certificates-and-hostnames_serial_number:
      type: string
      description: The serial number on the uploaded certificate.
      example: '6743787633689793699141714808227354901'
    dns_dns_analytics_api_time_delta:
      type: string
      description: Unit of time to group data by.
      enum:
      - all
      - auto
      - year
      - quarter
      - month
      - week
      - day
      - hour
      - dekaminute
      - minute
      example: hour
    api-shield_api_discovery_origin:
      type: string
      description: '* `ML` - Discovered operation was sourced using ML API Discovery * `SessionIdentifier` - Discovered operation was sourced using Session Identifier API Discovery

        '
      enum:
      - ML
      - SessionIdentifier
    zones_nel:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: Zone setting identifier.
            enum:
            - nel
            example: nel
          value:
            $ref: '#/components/schemas/zones_nel_value'
      title: Network Error Logging
      description: 'Enable Network Error Logging reporting on your zone. (Beta) '
    api-shield_validation_override_mitigation_action_write:
      type: string
      description: "When set, this overrides both zone level and operation level mitigation actions.\n\n  - `none` will skip running schema validation entirely for the request\n  - `null` indicates that no override is in place\n\nTo clear any override, use the special value `disable_override` or `null`\n"
      enum:
      - none
      - disable_override
      - null
      example: none
      nullable: true
    dweb-config_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/dweb-config_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/dweb-config_result_info'
      type: object
    dns_dns_analytics_api_sort:
      type: string
      description: A comma-separated list of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).
      example: +responseCode,-queryName
    tls-certificates-and-hostnames_zone-authenticated-origin-pull:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_certificateObject'
      type: object
      properties:
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate'
        enabled:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        private_key:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_private_key'
    access_components-schemas-name:
      type: string
      description: The name of the Access group.
      example: Allow devs
    waitingroom_additional_routes:
      type: array
      description: 'Only available for the Waiting Room Advanced subscription. Additional hostname and path combinations to which this waiting room will be applied. There is an implied wildcard at the end of the path. The hostname and path combination must be unique to this and all other waiting rooms. '
      items:
        type: object
        properties:
          host:
            type: string
            description: The hostname to which this waiting room will be applied (no wildcards). The hostname must be the primary domain, subdomain, or custom hostname (if using SSL for SaaS) of this zone. Please do not include the scheme (http:// or https://).
            example: shop2.example.com
          path:
            type: string
            description: Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
            default: /
            example: /shop2/checkout
    legacy-jhs_overrides_components-schemas-id:
      type: string
      description: The unique identifier of the WAF override.
      example: de677e5818985db1285d0e80225f06e5
      readOnly: true
      maxLength: 32
    zones_true_client_ip_header_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    legacy-jhs_anomaly_package:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_package_definition'
      - properties:
          action_mode:
            $ref: '#/components/schemas/legacy-jhs_action_mode'
          description:
            $ref: '#/components/schemas/legacy-jhs_anomaly_description'
          detection_mode:
            $ref: '#/components/schemas/legacy-jhs_anomaly_detection_mode'
          name:
            $ref: '#/components/schemas/legacy-jhs_anomaly_name'
          sensitivity:
            $ref: '#/components/schemas/legacy-jhs_sensitivity'
      title: Anomaly detection WAF package (OWASP)
      required:
      - id
      - name
      - description
      - zone_id
      - detection_mode
      - sensitivity
      - action_mode
    rulesets_schemas-request_model:
      type: object
      properties:
        scope:
          $ref: '#/components/schemas/rulesets_scope'
        type:
          $ref: '#/components/schemas/rulesets_type'
    rulesets_scope:
      type: string
      description: The scope of the URL normalization.
      example: incoming
    page-shield_pageshield-policy-value:
      type: string
      description: The policy which will be applied
      example: script-src 'none';
    dns-records_CNAMERecord:
      allOf:
      - properties:
          content:
            description: A valid hostname. Must not match the record's name.
          name:
            $ref: '#/components/schemas/dns-records_name'
          proxied:
            $ref: '#/components/schemas/dns-records_proxied'
          type:
            type: string
            description: Record type.
            enum:
            - CNAME
            example: CNAME
      - $ref: '#/components/schemas/dns-records_base'
      title: CNAME Record
      required:
      - type
      - name
      - content
    api-shield_basic_operation:
      type: object
      required:
      - method
      - host
      - endpoint
      properties:
        endpoint:
          $ref: '#/components/schemas/api-shield_endpoint'
        host:
          $ref: '#/components/schemas/api-shield_host'
        method:
          $ref: '#/components/schemas/api-shield_method'
    snippets-api_snippet:
      type: object
      description: Snippet Information
      properties:
        created_on:
          type: string
          description: Creation time of the snippet
          example: 2023-07-24-00:00:00
        modified_on:
          type: string
          description: Modification time of the snippet
          example: 2023-07-24-00:00:00
        snippet_name:
          $ref: '#/components/schemas/snippets-api_snippet_name'
    dns-records_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    workers_api-response-single-id:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            required:
            - id
            properties:
              id:
                $ref: '#/components/schemas/workers_identifier'
      type: object
    speed_cloudflare_fonts_value:
      type: string
      description: Whether the feature is enabled or disabled.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    bot-management_fight_mode:
      type: boolean
      description: Whether to enable Bot Fight Mode.
      example: true
    bill-subs-api_legacy_discount:
      type: boolean
      description: Indicates whether this plan has a legacy discount applied.
      default: false
      example: false
    dns-records_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/dns-records_messages'
        messages:
          $ref: '#/components/schemas/dns-records_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    dns-records_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    tls-certificates-and-hostnames_certificate_response_id_only:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
    waitingroom_event_description:
      type: string
      description: A note that you can use to add more details about the event.
      default: ''
      example: Production event - DO NOT MODIFY
    tls-certificates-and-hostnames_components-schemas-serial_number:
      type: string
      description: The serial number on the created Client Certificate.
      example: 3bb94ff144ac567b9f75ad664b6c55f8d5e48182
      readOnly: true
    legacy-jhs_zonelockdown:
      required:
      - id
      - created_on
      - modified_on
      - paused
      - description
      - urls
      - configurations
      properties:
        configurations:
          $ref: '#/components/schemas/legacy-jhs_configurations'
        created_on:
          $ref: '#/components/schemas/legacy-jhs_created_on'
        description:
          $ref: '#/components/schemas/legacy-jhs_lockdowns_components-schemas-description'
        id:
          $ref: '#/components/schemas/legacy-jhs_lockdowns_components-schemas-id'
        modified_on:
          $ref: '#/components/schemas/legacy-jhs_components-schemas-modified_on'
        paused:
          $ref: '#/components/schemas/legacy-jhs_schemas-paused'
        urls:
          $ref: '#/components/schemas/legacy-jhs_schemas-urls'
    dnssec_algorithm:
      type: string
      description: Algorithm key code.
      example: '13'
      nullable: true
      readOnly: true
    email_rules_response_collection:
      allOf:
      - $ref: '#/components/schemas/email_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/email_rules'
          result_info:
            type: object
            properties:
              count:
                example: 1
              page:
                example: 1
              per_page:
                example: 20
              total_count:
                example: 1
    rulesets_Message:
      type: object
      title: Message
      description: A message.
      required:
      - message
      properties:
        code:
          type: integer
          title: Code
          description: A unique code for this message.
          example: 10000
        message:
          type: string
          title: Description
          description: A text description of this message.
          example: something bad happened
          minLength: 1
        source:
          type: object
          title: Source
          description: The source of this message.
          required:
          - pointer
          properties:
            pointer:
              type: string
              title: Pointer
              description: A JSON pointer to the field that is the source of the message.
              example: /rules/0/action
              minLength: 1
    tls-certificates-and-hostnames_hostname_certid_input:
      type: object
      properties:
        cert_id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_cert_id'
        enabled:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled'
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostname'
    page-shield_updated_at:
      type: string
      description: The timestamp of when Page Shield was last updated.
      example: '2022-10-12T17:56:52.083582+01:00'
    dns_dns_analytics_api_api-response-single:
      allOf:
      - $ref: '#/components/schemas/dns_dns_analytics_api_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    dns_dns_analytics_api_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    waitingroom_query_event:
      type: object
      required:
      - name
      - event_start_time
      - event_end_time
      properties:
        custom_page_html:
          $ref: '#/components/schemas/waitingroom_event_custom_page_html'
        description:
          $ref: '#/components/schemas/waitingroom_event_description'
        disable_session_renewal:
          $ref: '#/components/schemas/waitingroom_event_disable_session_renewal'
        event_end_time:
          $ref: '#/components/schemas/waitingroom_event_end_time'
        event_start_time:
          $ref: '#/components/schemas/waitingroom_event_start_time'
        name:
          $ref: '#/components/schemas/waitingroom_event_name'
        new_users_per_minute:
          $ref: '#/components/schemas/waitingroom_event_new_users_per_minute'
        prequeue_start_time:
          $ref: '#/components/schemas/waitingroom_event_prequeue_start_time'
        queueing_method:
          $ref: '#/components/schemas/waitingroom_event_queueing_method'
        session_duration:
          $ref: '#/components/schemas/waitingroom_event_session_duration'
        shuffle_at_event_start:
          $ref: '#/components/schemas/waitingroom_event_shuffle_at_event_start'
        suspended:
          $ref: '#/components/schemas/waitingroom_event_suspended'
        total_active_users:
          $ref: '#/components/schemas/waitingroom_event_total_active_users'
    access_type:
      type: string
      description: The application type.
      enum:
      - self_hosted
      - saas
      - ssh
      - vnc
      - app_launcher
      - warp
      - biso
      - bookmark
      - dash_sso
      example: self_hosted
    waitingroom_event_details_new_users_per_minute:
      type: integer
    zones_base:
      required:
      - id
      - value
      properties:
        editable:
          type: boolean
          description: Whether or not this setting can be modified for this zone (based on your Cloudflare plan level).
          enum:
          - true
          - false
          default: true
          readOnly: true
        id:
          type: string
          description: Identifier of the zone setting.
          example: development_mode
        modified_on:
          type: string
          format: date-time
          description: last time this setting was modified.
          example: '2014-01-01T05:20:00.12345Z'
          nullable: true
          readOnly: true
        value:
          description: Current value of the zone setting.
          example: 'on'
    tls-certificates-and-hostnames_universal:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-enabled'
    healthchecks_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    email_email_setting_modified:
      type: string
      format: date-time
      description: The date and time the settings have been modified.
      example: '2014-01-02T02:20:00Z'
      readOnly: true
    access_rule:
      oneOf:
      - $ref: '#/components/schemas/access_email_rule'
      - $ref: '#/components/schemas/access_email_list_rule'
      - $ref: '#/components/schemas/access_domain_rule'
      - $ref: '#/components/schemas/access_everyone_rule'
      - $ref: '#/components/schemas/access_ip_rule'
      - $ref: '#/components/schemas/access_ip_list_rule'
      - $ref: '#/components/schemas/access_certificate_rule'
      - $ref: '#/components/schemas/access_access_group_rule'
      - $ref: '#/components/schemas/access_azure_group_rule'
      - $ref: '#/components/schemas/access_github_organization_rule'
      - $ref: '#/components/schemas/access_gsuite_group_rule'
      - $ref: '#/components/schemas/access_okta_group_rule'
      - $ref: '#/components/schemas/access_saml_group_rule'
      - $ref: '#/components/schemas/access_service_token_rule'
      - $ref: '#/components/schemas/access_any_valid_service_token_rule'
      - $ref: '#/components/schemas/access_external_evaluation_rule'
      - $ref: '#/components/schemas/access_country_rule'
      - $ref: '#/components/schemas/access_authentication_method_rule'
      - $ref: '#/components/schemas/access_device_posture_rule'
      type: object
    bot-management_suppress_session_score:
      type: boolean
      description: Whether to disable tracking the highest bot score for a session in the Bot Management cookie.
      example: false
    load-balancing_adaptive_routing:
      type: object
      description: Controls features that modify the routing of requests to pools and origins in response to dynamic conditions, such as during the interval between active health monitoring requests. For example, zero-downtime failover occurs immediately when an origin becomes unavailable due to HTTP 521, 522, or 523 response codes. If there is another healthy origin in the same pool, the request is retried once against this alternate origin.
      properties:
        failover_across_pools:
          type: boolean
          description: Extends zero-downtime failover of requests to healthy origins from alternate pools, when no healthy alternate exists in the same pool, according to the failover order defined by traffic and origin steering. When set false (the default) zero-downtime failover will only occur between origins within the same pool. See `session_affinity_attributes` for control over when sessions are broken or reassigned.
          default: false
          example: true
    access_schemas-name:
      type: string
      description: The name of the identity provider, shown to users on the login page.
      example: Widget Corps IDP
    legacy-jhs_dns_name:
      type: string
      format: hostname
      description: The name of the DNS record associated with the application.
      example: ssh.example.com
    access_id:
      type: string
      description: The ID of the CA.
      example: 7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9
      readOnly: true
      maxLength: 48
    dns-custom-nameservers_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/dns-custom-nameservers_messages'
        messages:
          $ref: '#/components/schemas/dns-custom-nameservers_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    legacy-jhs_body:
      type: string
      description: The response body to return. The value must conform to the configured content type.
      example: <error>This request has been rate-limited.</error>
      maxLength: 10240
    dweb-config_single_response:
      allOf:
      - $ref: '#/components/schemas/dweb-config_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/dweb-config_web3-hostname'
    api-shield_api-response-single:
      allOf:
      - $ref: '#/components/schemas/api-shield_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
              nullable: true
            - type: string
              nullable: true
      type: object
    access_ip_rule:
      type: object
      title: IP ranges
      description: Matches an IP address block.
      required:
      - ip
      properties:
        ip:
          type: object
          required:
          - ip
          properties:
            ip:
              type: string
              description: An IPv4 or IPv6 CIDR block.
              example: 2400:cb00:21:10a::/64
    zones_response_buffering_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    load-balancing_region_pools:
      type: object
      description: A mapping of region codes to a list of pool IDs (ordered by their failover priority) for the given region. Any regions not explicitly defined will fall back to using default_pools.
      example:
        ENAM:
        - 00920f38ce07c2e2f4df50b1f61d4194
        WNAM:
        - de90f38ced07c2e2f4df50b1f61d4194
        - 9290f38c5d07c2e2f4df57b1f61d4196
    tls-certificates-and-hostnames_hostname_aop_single_response:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_certid_object'
    waitingroom_path:
      type: string
      description: Sets the path within the host to enable the waiting room on. The waiting room will be enabled for all subpaths as well. If there are two waiting rooms on the same subpath, the waiting room for the most specific path will be chosen. Wildcards and query parameters are not supported.
      default: /
      example: /shop/checkout
    email_email_settings_properties:
      type: object
      properties:
        created:
          $ref: '#/components/schemas/email_email_setting_created'
        enabled:
          $ref: '#/components/schemas/email_email_setting_enabled'
        id:
          $ref: '#/components/schemas/email_email_setting_identifier'
        modified:
          $ref: '#/components/schemas/email_email_setting_modified'
        name:
          $ref: '#/components/schemas/email_email_setting_name'
        skip_wizard:
          $ref: '#/components/schemas/email_email_setting_skip-wizard'
        status:
          $ref: '#/components/schemas/email_email_setting_status'
        tag:
          $ref: '#/components/schemas/email_email_setting_tag'
    legacy-jhs_filter-delete-response-collection:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/legacy-jhs_filter'
              - type: object
                required:
                - id
    tls-certificates-and-hostnames_hostname_association:
      type: object
      properties:
        hostnames:
          type: array
          items:
            type: string
            example: api.example.com
        mtls_certificate_id:
          type: string
          description: The UUID for a certificate that was uploaded to the mTLS Certificate Management endpoint. If no mtls_certificate_id is given, the hostnames will be associated to your active Cloudflare Managed CA.
          minLength: 36
          maxLength: 36
    tls-certificates-and-hostnames_certificate:
      type: string
      description: The zone's SSL certificate or certificate and the intermediate(s).
      example: '--BEGIN CERTIFICATE--

        MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV

        BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX

        aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF

        MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50

        ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB

        CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1

        CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB

        KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5

        0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI

        dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2

        izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4

        9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI

        GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV

        BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF

        MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2

        2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP

        Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG

        SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq

        2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw

        YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=

        --END CERTIFICATE--

        '
    zones_paused:
      type: boolean
      description: 'Indicates whether the zone is only using Cloudflare DNS services. A

        true value means the zone will not receive security or performance

        benefits.

        '
      default: false
      readOnly: true
    access_user_seat_expiration_inactive_time:
      type: string
      description: 'The amount of time a user seat is inactive before it expires. When the user seat exceeds the set time of inactivity, the user is removed as an active seat and no longer counts against your Teams seat count. Must be in the format `300ms` or `2h45m`. Valid time units are: `ns`, `us` (or `µs`), `ms`, `s`, `m`, `h`.'
      example: 720h
    dns-records_page:
      type: number
      description: Page number of paginated results.
      default: 1
      minimum: 1
    rulesets_request_list:
      type: array
      items:
        $ref: '#/components/schemas/rulesets_request_model'
    load-balancing_components-schemas-description:
      type: string
      description: Object description.
      example: Load Balancer for www.example.com
    tls-certificates-and-hostnames_validation_method_definition:
      type: string
      description: Desired validation method.
      enum:
      - http
      - cname
      - txt
      - email
      example: txt
    api-shield_operation_schema_validation_settings_multiple_request:
      type: object
      example:
        3818d821-5901-4147-a474-f5f5aec1d54e:
          mitigation_action: log
        b17c8043-99a0-4202-b7d9-8f7cdbee02cd:
          mitigation_action: block
    tls-certificates-and-hostnames_schemas-status:
      type: string
      description: Status of the Keyless SSL.
      enum:
      - active
      - deleted
      example: active
      readOnly: true
    bot-management_sbfm_definitely_config:
      allOf:
      - $ref: '#/components/schemas/bot-management_base_config'
      - properties:
          optimize_wordpress:
            $ref: '#/components/schemas/bot-management_optimize_wordpress'
          sbfm_definitely_automated:
            $ref: '#/components/schemas/bot-management_sbfm_definitely_automated'
          sbfm_static_resource_protection:
            $ref: '#/components/schemas/bot-management_sbfm_static_resource_protection'
          sbfm_verified_bots:
            $ref: '#/components/schemas/bot-management_sbfm_verified_bots'
      title: SBFM Pro Plan
    dns_dns_analytics_api_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/dns_dns_analytics_api_messages'
        messages:
          $ref: '#/components/schemas/dns_dns_analytics_api_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    dnssec_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/dnssec_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/dnssec_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    dweb-config_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    tls-certificates-and-hostnames_certificate-packs_components-schemas-status:
      type: string
      description: Status of certificate pack.
      enum:
      - initializing
      - pending_validation
      - deleted
      - pending_issuance
      - pending_deployment
      - pending_deletion
      - pending_expiration
      - expired
      - active
      - initializing_timed_out
      - validation_timed_out
      - issuance_timed_out
      - deployment_timed_out
      - deletion_timed_out
      - pending_cleanup
      - staging_deployment
      - staging_active
      - deactivating
      - inactive
      - backup_issued
      - holding_deployment
      example: initializing
    waitingroom_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    waf-managed-rules_anomaly_rule:
      allOf:
      - $ref: '#/components/schemas/waf-managed-rules_schemas-base'
      - properties:
          allowed_modes:
            $ref: '#/components/schemas/waf-managed-rules_allowed_modes_anomaly'
          mode:
            $ref: '#/components/schemas/waf-managed-rules_mode_anomaly'
      title: Anomaly detection WAF rule
      description: When triggered, anomaly detection WAF rules contribute to an overall threat score that will determine if a request is considered malicious. You can configure the total scoring threshold through the 'sensitivity' property of the WAF package.
      required:
      - id
      - description
      - priority
      - allowed_modes
      - mode
      - group
      - package_id
    access_allowed_methods:
      type: array
      description: Allowed HTTP request methods.
      example:
      - GET
      items:
        type: string
        enum:
        - GET
        - POST
        - HEAD
        - PUT
        - DELETE
        - CONNECT
        - OPTIONS
        - TRACE
        - PATCH
    page-shield_use_cloudflare_reporting_endpoint:
      type: boolean
      description: When true, CSP reports will be sent to https://csp-reporting.cloudflare.com/cdn-cgi/script_monitor/report
      example: true
    tls-certificates-and-hostnames_verification_info:
      type: object
      description: Certificate's required verification information.
      properties:
        record_name:
          type: string
          format: hostname
          description: Name of CNAME record.
          enum:
          - record_name
          - http_url
          - cname
          - txt_name
          example: b3b90cfedd89a3e487d3e383c56c4267.example.com
        record_target:
          type: string
          format: hostname
          description: Target of CNAME record.
          enum:
          - record_value
          - http_body
          - cname_target
          - txt_value
          example: 6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com
    zones_ipv6_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'off'
      - 'on'
      default: 'off'
    email_rule_priority:
      type: number
      description: Priority of the routing rule.
      default: 0
      minimum: 0
    zones_opportunistic_onion_value:
      type: string
      description: 'Value of the zone setting.

        Notes: Default value depends on the zone''s plan level.'
      enum:
      - 'on'
      - 'off'
      default: 'off'
    legacy-jhs_rewrite_action:
      type: object
      description: Specifies that, when a WAF rule matches, its configured action will be replaced by the action configured in this object.
      properties:
        block:
          $ref: '#/components/schemas/legacy-jhs_waf_rewrite_action'
        challenge:
          example: block
        default:
          example: block
        disable:
          $ref: '#/components/schemas/legacy-jhs_waf_rewrite_action'
        simulate:
          example: disable
    secondary-dns_disable_transfer_result:
      type: string
      description: The zone transfer status of a primary zone
      example: Disabled
    load-balancing_ttl:
      type: number
      description: Time to live (TTL) of the DNS entry for the IP address returned by this load balancer. This only applies to gray-clouded (unproxied) load balancers.
      example: 30
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status:
      description: Status of the certificate or the association.
      enum:
      - initializing
      - pending_deployment
      - pending_deletion
      - active
      - deleted
      - deployment_timed_out
      - deletion_timed_out
      example: active
      readOnly: true
    workers_namespace_identifier:
      type: string
      description: Namespace identifier tag.
      example: 0f2ac74b498b48028cb68387c421e279
      readOnly: true
      maxLength: 32
    legacy-jhs_firewalluablock_response_single:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - type: object
        properties:
          result:
            type: object
    healthchecks_api-response-single:
      allOf:
      - $ref: '#/components/schemas/healthchecks_api-response-common'
      - properties:
          result:
            oneOf:
            - type: object
            - type: string
      type: object
    logpush_dataset:
      type: string
      description: Name of the dataset.
      example: http_requests
      nullable: true
      maxLength: 256
      pattern: ^[a-zA-Z0-9_\-]*$
    access_policies_components-schemas-name:
      type: string
      description: The name of the Access policy.
      example: Allow devs
    cache-purge_schemas-identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    waitingroom_event_details_result:
      type: object
      properties:
        created_on:
          $ref: '#/components/schemas/waitingroom_timestamp'
        custom_page_html:
          $ref: '#/components/schemas/waitingroom_event_details_custom_page_html'
        description:
          $ref: '#/components/schemas/waitingroom_event_description'
        disable_session_renewal:
          $ref: '#/components/schemas/waitingroom_event_details_disable_session_renewal'
        event_end_time:
          $ref: '#/components/schemas/waitingroom_event_end_time'
        event_start_time:
          $ref: '#/components/schemas/waitingroom_event_start_time'
        id:
          $ref: '#/components/schemas/waitingroom_event_id'
        modified_on:
          $ref: '#/components/schemas/waitingroom_timestamp'
        name:
          $ref: '#/components/schemas/waitingroom_event_name'
        new_users_per_minute:
          $ref: '#/components/schemas/waitingroom_event_details_new_users_per_minute'
        prequeue_start_time:
          $ref: '#/components/schemas/waitingroom_event_prequeue_start_time'
        queueing_method:
          $ref: '#/components/schemas/waitingroom_event_details_queueing_method'
        session_duration:
          $ref: '#/components/schemas/waitingroom_event_details_session_duration'
        shuffle_at_event_start:
          $ref: '#/components/schemas/waitingroom_event_shuffle_at_event_start'
        suspended:
          $ref: '#/components/schemas/waitingroom_event_suspended'
        total_active_users:
          $ref: '#/components/schemas/waitingroom_event_details_total_active_users'
    zones_automatic_platform_optimization:
      type: object
      required:
      - enabled
      - cf
      - wordpress
      - wp_plugin
      - hostnames
      - cache_by_device_type
      properties:
        cache_by_device_type:
          type: boolean
          description: Indicates whether or not [cache by device type](https://developers.cloudflare.com/automatic-platform-optimization/reference/cache-device-type/) is enabled.
          example: false
        cf:
          type: boolean
          description: Indicates whether or not Cloudflare proxy is enabled.
          default: false
          example: true
        enabled:
          type: boolean
          description: Indicates whether or not Automatic Platform Optimization is enabled.
          default: false
          example: true
        hostnames:
          type: array
          description: An array of hostnames where Automatic Platform Optimization for WordPress is activated.
          example:
          - www.example.com
          - example.com
          - shop.example.com
          items:
            type: string
            format: hostname
        wordpress:
          type: boolean
          description: Indicates whether or not site is powered by WordPress.
          default: false
          example: true
        wp_plugin:
          type: boolean
          description: Indicates whether or not [Cloudflare for WordPress plugin](https://wordpress.org/plugins/cloudflare/) is installed.
          default: false
          example: true
    zones_cache_level:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - cache_level
            example: cache_level
          value:
            $ref: '#/components/schemas/zones_cache_level_value'
      title: Cloudflare Cache Level
      description: Cache Level functions based off the setting level. The basic setting will cache most static resources (i.e., css, images, and JavaScript). The simplified setting will ignore the query string when delivering a cached resource. The aggressive setting will cache all static resources, including ones with a query string. (https://support.cloudflare.com/hc/en-us/articles/200168256).
    waitingroom_waiting_room_id:
      example: 699d98642c564d2e855e9661899b7252
    waitingroom_update_rules:
      type: array
      items:
        $ref: '#/components/schemas/waitingroom_create_rule'
    api-shield_timestamp:
      type: string
      format: date-time
      example: '2014-01-01T05:20:00.12345Z'
      readOnly: true
    dns-records_CAARecord:
      allOf:
      - properties:
          content:
            type: string
            description: Formatted CAA content. See 'data' to set CAA properties.
            readOnly: true
          data:
            type: object
            description: Components of a CAA record.
            properties:
              flags:
                type: number
                description: Flags for the CAA record.
                example: 1
                minimum: 0
                maximum: 255
              tag:
                type: string
                description: 'Name of the property controlled by this record (e.g.: issue, issuewild, iodef).'
                example: issue
              value:
                type: string
                description: Value of the record. This field's semantics depend on the chosen tag.
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - CAA
            example: CAA
      - $ref: '#/components/schemas/dns-records_base'
      title: CAA Record
      required:
      - type
      - name
      - data
    observatory_trend:
      type: object
      properties:
        cls:
          type: array
          description: Cumulative Layout Shift trend.
          items:
            type: number
            nullable: true
        fcp:
          type: array
          description: First Contentful Paint trend.
          items:
            type: number
            nullable: true
        lcp:
          type: array
          description: Largest Contentful Paint trend.
          items:
            type: number
            nullable: true
        performanceScore:
          type: array
          description: The Lighthouse score trend.
          items:
            type: number
            nullable: true
        si:
          type: array
          description: Speed Index trend.
          items:
            type: number
            nullable: true
        tbt:
          type: array
          description: Total Blocking Time trend.
          items:
            type: number
            nullable: true
        ttfb:
          type: array
          description: Time To First Byte trend.
          items:
            type: number
            nullable: true
        tti:
          type: array
          description: Time To Interactive trend.
          items:
            type: number
            nullable: true
    bill-subs-api_schemas-component_values:
      type: array
      description: Array of available components values for the plan.
      items:
        $ref: '#/components/schemas/bill-subs-api_component-value'
    legacy-jhs_origin_traffic:
      type: boolean
      description: 'When true, only the uncached traffic served from your origin servers will count towards rate limiting. In this case, any cached traffic served by Cloudflare will not count towards rate limiting. This field is optional.

        Notes: This field is deprecated. Instead, use response headers and set "origin_traffic" to "false" to avoid legacy behaviour interacting with the "response_headers" property.'
    legacy-jhs_origin_dns_name:
      type: string
      format: hostname
      description: The name of the DNS record associated with the origin.
      example: origin.example.com
    tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-certificate:
      type: string
      description: The zone's leaf certificate.
      example: '--BEGIN CERTIFICATE--

        MIIDtTCCAp2gAwIBAgIJAMHAwfXZ5/PWMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV

        BAYTAkFVMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX

        aWRnaXRzIFB0eSBMdGQwHhcNMTYwODI0MTY0MzAxWhcNMTYxMTIyMTY0MzAxWjBF

        MQswCQYDVQQGEwJBVTETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50

        ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB

        CgKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmGdtcGbg/1

        CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKnabIRuGvB

        KwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpidtnKX/a+5

        0GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+pyFxIXjbEI

        dZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pEewooaeO2

        izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABo4GnMIGkMB0GA1UdDgQWBBT/LbE4

        9rWf288N6sJA5BRb6FJIGDB1BgNVHSMEbjBsgBT/LbE49rWf288N6sJA5BRb6FJI

        GKFJpEcwRTELMAkGA1UEBhMCQVUxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV

        BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAMHAwfXZ5/PWMAwGA1UdEwQF

        MAMBAf8wDQYJKoZIhvcNAQELBQADggEBAHHFwl0tH0quUYZYO0dZYt4R7SJ0pCm2

        2satiyzHl4OnXcHDpekAo7/a09c6Lz6AU83cKy/+x3/djYHXWba7HpEu0dR3ugQP

        Mlr4zrhd9xKZ0KZKiYmtJH+ak4OM4L3FbT0owUZPyjLSlhMtJVcoRp5CJsjAMBUG

        SvD8RX+T01wzox/Qb+lnnNnOlaWpqu8eoOenybxKp1a9ULzIVvN/LAcc+14vioFq

        2swRWtmocBAs8QR9n4uvbpiYvS8eYueDCWMM4fvFfBhaDZ3N9IbtySh3SpFdQDhw

        YbjM2rxXiyLGxB4Bol7QTv4zHif7Zt89FReT/NBy4rzaskDJY5L6xmY=

        --END CERTIFICATE--

        '
    bill-subs-api_current_period_end:
      type: string
      format: date-time
      description: The end of the current period and also when the next billing is due.
      example: '2014-03-31T12:20:00Z'
      readOnly: true
    observatory_trend-response:
      allOf:
      - $ref: '#/components/schemas/observatory_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/observatory_trend'
    dns_dns_analytics_api_until:
      type: string
      format: date-time
      description: End date and time of requesting data period in ISO 8601 format.
      example: '2023-11-11T13:00:00Z'
    waf-managed-rules_mode:
      type: string
      description: The state of the rules contained in the rule group. When `on`, the rules in the group are configurable/usable.
      enum:
      - 'on'
      - 'off'
      default: 'on'
    access_generic-oauth-config:
      type: object
      properties:
        client_id:
          type: string
          description: Your OAuth Client ID
          example: <your client id>
        client_secret:
          type: string
          description: Your OAuth Client Secret
          example: <your client secret>
    dns-records_TXTRecord:
      allOf:
      - properties:
          content:
            type: string
            description: Text content for the record.
            example: example text content
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - TXT
            example: TXT
      - $ref: '#/components/schemas/dns-records_base'
      title: TXT Record
      required:
      - type
      - name
      - content
    access_precedence:
      type: integer
      description: The order of execution for this policy. Must be unique for each policy.
    zones_schemas-identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    data-zone-analytics-api_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    waf-managed-rules_rule_response_collection:
      allOf:
      - $ref: '#/components/schemas/waf-managed-rules_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/waf-managed-rules_rule'
    load-balancing_rules:
      type: array
      description: 'BETA Field Not General Access: A list of rules for this load balancer to execute.'
      items:
        type: object
        description: A rule object containing conditions and overrides for this load balancer to evaluate.
        properties:
          condition:
            type: string
            description: The condition expressions to evaluate. If the condition evaluates to true, the overrides or fixed_response in this rule will be applied. An empty condition is always true. For more details on condition expressions, please see https://developers.cloudflare.com/load-balancing/understand-basics/load-balancing-rules/expressions.
            example: http.request.uri.path contains "/testing"
          disabled:
            type: boolean
            description: Disable this specific rule. It will no longer be evaluated by this load balancer.
            default: false
          fixed_response:
            type: object
            description: A collection of fields used to directly respond to the eyeball instead of routing to a pool. If a fixed_response is supplied the rule will be marked as terminates.
            properties:
              content_type:
                type: string
                description: The http 'Content-Type' header to include in the response.
                example: application/json
                maxLength: 32
              location:
                type: string
                description: The http 'Location' header to include in the response.
                example: www.example.com
                maxLength: 2048
              message_body:
                type: string
                description: Text to include as the http body.
                example: Testing Hello
                maxLength: 1024
              status_code:
                type: integer
                description: The http status code to respond with.
          name:
            type: string
            description: Name of this rule. Only used for human readability.
            example: route the path /testing to testing datacenter.
            maxLength: 200
          overrides:
            type: object
            description: A collection of overrides to apply to the load balancer when this rule's condition is true. All fields are optional.
            properties:
              adaptive_routing:
                $ref: '#/components/schemas/load-balancing_adaptive_routing'
              country_pools:
                $ref: '#/components/schemas/load-balancing_country_pools'
              default_pools:
                $ref: '#/components/schemas/load-balancing_default_pools'
              fallback_pool:
                $ref: '#/components/schemas/load-balancing_fallback_pool'
              location_strategy:
                $ref: '#/components/schemas/load-balancing_location_strategy'
              pop_pools:
                $ref: '#/components/schemas/load-balancing_pop_pools'
              random_steering:
                $ref: '#/components/schemas/load-balancing_random_steering'
              region_pools:
                $ref: '#/components/schemas/load-balancing_region_pools'
              session_affinity:
                $ref: '#/components/schemas/load-balancing_session_affinity'
              session_affinity_attributes:
                $ref: '#/components/schemas/load-balancing_session_affinity_attributes'
              session_affinity_ttl:
                $ref: '#/components/schemas/load-balancing_session_affinity_ttl'
              steering_policy:
                $ref: '#/components/schemas/load-balancing_steering_policy'
              ttl:
                $ref: '#/components/schemas/load-balancing_ttl'
          priority:
            type: integer
            description: The order in which rules should be executed in relation to each other. Lower values are executed first. Values do not need to be sequential. If no value is provided for any rule the array order of the rules field will be used to assign a priority.
            default: 0
            minimum: 0
          terminates:
            type: boolean
            description: If this rule's condition is true, this causes rule evaluation to stop after processing this rule.
            default: false
    waitingroom_zone_settings_response:
      allOf:
      - $ref: '#/components/schemas/waitingroom_api-response-single'
      - required:
        - result
        properties:
          result:
            type: object
            required:
            - search_engine_crawler_bypass
            properties:
              search_engine_crawler_bypass:
                $ref: '#/components/schemas/waitingroom_search_engine_crawler_bypass'
    waf-managed-rules_modified_rules_count:
      type: number
      description: The number of rules within the group that have been modified from their default configuration.
      default: 0
      example: 2
      readOnly: true
    zones_always_online:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - always_online
            example: always_online
          value:
            $ref: '#/components/schemas/zones_always_online_value'
      title: Always Online Mode
      description: When enabled, Cloudflare serves limited copies of web pages available from the [Internet Archive's Wayback Machine](https://archive.org/web/) if your server is offline. Refer to [Always Online](https://developers.cloudflare.com/cache/about/always-online) for more information.
    access_duration:
      type: string
      description: 'The duration for how long the service token will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h. The default is 1 year in hours (8760h).'
      example: 60m
    api-shield_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/api-shield_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/api-shield_messages'
          example: []
        result:
          type: object
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          example: false
    waf-managed-rules_schemas-description:
      type: string
      description: The public description of the WAF rule.
      example: SQL injection prevention for SELECT statements
      readOnly: true
    access_aud:
      type: string
      description: The Application Audience (AUD) tag. Identifies the application associated with the CA.
      example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893
      readOnly: true
      maxLength: 64
    tls-certificates-and-hostnames_client-certificates_components-schemas-certificate_authority:
      type: object
      description: Certificate Authority used to issue the Client Certificate
      properties:
        id:
          type: string
          example: 568b6b74-7b0c-4755-8840-4e3b8c24adeb
        name:
          type: string
          example: Cloudflare Managed CA for account
    legacy-jhs_created:
      type: string
      format: date-time
      description: When the Application was created.
      example: '2014-01-02T02:20:00Z'
      readOnly: true
    waitingroom_new_users_per_minute:
      type: integer
      description: Sets the number of new users that will be let into the route every minute. This value is used as baseline for the number of users that are let in per minute. So it is possible that there is a little more or little less traffic coming to the route based on the traffic patterns at that time around the world.
      minimum: 200
      maximum: 2147483647
    dns_dns_analytics_api_since:
      type: string
      format: date-time
      description: Start date and time of requesting data period in ISO 8601 format.
      example: '2023-11-11T12:00:00Z'
    email_catch_all_rule:
      type: object
      properties:
        actions:
          $ref: '#/components/schemas/email_rule_catchall-actions'
        enabled:
          $ref: '#/components/schemas/email_rule_enabled'
        id:
          $ref: '#/components/schemas/email_rule_identifier'
        matchers:
          $ref: '#/components/schemas/email_rule_catchall-matchers'
        name:
          $ref: '#/components/schemas/email_rule_name'
        tag:
          $ref: '#/components/schemas/email_rule_tag'
    secondary-dns_identifier:
      example: 269d8f4853475ca241c4e730be286b20
      readOnly: true
    dns-records_base:
      properties:
        comment:
          $ref: '#/components/schemas/dns-records_comment'
        created_on:
          type: string
          format: date-time
          description: When the record was created.
          example: '2014-01-01T05:20:00.12345Z'
          readOnly: true
        id:
          $ref: '#/components/schemas/dns-records_identifier'
        locked:
          type: boolean
          description: Whether this record can be modified/deleted (true means it's managed by Cloudflare).
          example: false
          readOnly: true
        meta:
          type: object
          description: Extra Cloudflare-specific information about the record.
          readOnly: true
          properties:
            auto_added:
              type: boolean
              description: Will exist if Cloudflare automatically added this DNS record during initial setup.
              example: true
            source:
              type: string
              description: Where the record originated from.
              example: primary
        modified_on:
          type: string
          format: date-time
          description: When the record was last modified.
          example: '2014-01-01T05:20:00.12345Z'
          readOnly: true
        proxiable:
          type: boolean
          description: Whether the record can be proxied by Cloudflare or not.
          example: true
          readOnly: true
        tags:
          $ref: '#/components/schemas/dns-records_tags'
        ttl:
          $ref: '#/components/schemas/dns-records_ttl'
        zone_id:
          $ref: '#/components/schemas/dns-records_identifier'
        zone_name:
          type: string
          format: hostname
          description: The domain of the record.
          example: example.com
          readOnly: true
    api-shield_properties:
      type: array
      description: Requests information about certain properties.
      example:
      - auth_id_characteristics
      uniqueItems: true
      items:
        type: string
        enum:
        - auth_id_characteristics
        example: auth_id_characteristics
    legacy-jhs_firewall-rules_components-schemas-description:
      type: string
      description: An informative summary of the firewall rule.
      example: Blocks traffic identified during investigation for MIR-31
      maxLength: 500
    observatory_region:
      type: string
      description: A test region.
      enum:
      - asia-east1
      - asia-northeast1
      - asia-northeast2
      - asia-south1
      - asia-southeast1
      - australia-southeast1
      - europe-north1
      - europe-southwest1
      - europe-west1
      - europe-west2
      - europe-west3
      - europe-west4
      - europe-west8
      - europe-west9
      - me-west1
      - southamerica-east1
      - us-central1
      - us-east1
      - us-east4
      - us-south1
      - us-west1
      example: us-central1
    zones_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
    legacy-jhs_ip_search:
      type: string
      description: A single IP address to search for in existing rules.
      example: 1.2.3.4
    tls-certificates-and-hostnames_customhostname:
      properties:
        created_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_created_at'
        custom_metadata:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_metadata'
        custom_origin_server:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_server'
        custom_origin_sni:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_custom_origin_sni'
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        ownership_verification:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_ownership_verification'
        ownership_verification_http:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_ownership_verification_http'
        ssl:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_ssl'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-status'
        verification_errors:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_verification_errors'
    data-zone-analytics-api_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/data-zone-analytics-api_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/data-zone-analytics-api_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    api-shield_operation_feature_thresholds:
      type: object
      readOnly: true
      required:
      - period_seconds
      - suggested_threshold
      - p50
      - p90
      - p99
      - requests
      - auth_id_tokens
      - data_points
      - last_updated
      properties:
        thresholds:
          type: object
          properties:
            auth_id_tokens:
              $ref: '#/components/schemas/api-shield_auth_id_tokens'
            data_points:
              $ref: '#/components/schemas/api-shield_data_points'
            last_updated:
              $ref: '#/components/schemas/api-shield_timestamp'
            p50:
              $ref: '#/components/schemas/api-shield_p50'
            p90:
              $ref: '#/components/schemas/api-shield_p90'
            p99:
              $ref: '#/components/schemas/api-shield_p99'
            period_seconds:
              $ref: '#/components/schemas/api-shield_period_seconds'
            requests:
              $ref: '#/components/schemas/api-shield_requests'
            suggested_threshold:
              $ref: '#/components/schemas/api-shield_suggested_threshold'
    load-balancing_random_steering:
      type: object
      description: 'Configures pool weights.

        - `steering_policy="random"`: A random pool is selected with probability proportional to pool weights.

        - `steering_policy="least_outstanding_requests"`: Use pool weights to scale each pool''s outstanding requests.

        - `steering_policy="least_connections"`: Use pool weights to scale each pool''s open connections.'
      properties:
        default_weight:
          type: number
          description: The default weight for pools in the load balancer that are not specified in the pool_weights map.
          default: 1
          example: 0.2
          minimum: 0
          maximum: 1
          multipleOf: 0.1
        pool_weights:
          type: object
          description: A mapping of pool IDs to custom weights. The weight is relative to other pools in the load balancer.
          example:
            9290f38c5d07c2e2f4df57b1f61d4196: 0.5
            de90f38ced07c2e2f4df50b1f61d4194: 0.3
    legacy-jhs_origin_dns_type:
      type: string
      description: The type of DNS record associated with the origin. "" is used to specify a combination of A/AAAA records.
      enum:
      - ''
      - A
      - AAAA
      - SRV
      example: ''
    data-zone-analytics-api_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/data-zone-analytics-api_messages'
        messages:
          $ref: '#/components/schemas/data-zone-analytics-api_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    logpush_last_error:
      type: string
      format: date-time
      description: Records the last time the job failed. If not null, the job is currently failing. If null, the job has either never failed or has run successfully at least once since last failure. See also the error_message field.
      nullable: true
    dns-records_content:
      type: string
      description: DNS record content.
      example: 127.0.0.1
    page-shield_pageshield-policy:
      properties:
        action:
          $ref: '#/components/schemas/page-shield_pageshield-policy-action'
        description:
          $ref: '#/components/schemas/page-shield_pageshield-policy-description'
        enabled:
          $ref: '#/components/schemas/page-shield_pageshield-policy-enabled'
        expression:
          $ref: '#/components/schemas/page-shield_pageshield-policy-expression'
        id:
          $ref: '#/components/schemas/page-shield_pageshield-policy-id'
        value:
          $ref: '#/components/schemas/page-shield_pageshield-policy-value'
    waitingroom_timestamp:
      type: string
      format: date-time
      example: '2014-01-01T05:20:00.12345Z'
      readOnly: true
    load-balancing_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/load-balancing_result_info'
      type: object
    bill-subs-api_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    tls-certificates-and-hostnames_validation_record:
      type: object
      description: Certificate's required validation record.
      properties:
        emails:
          type: array
          description: The set of email addresses that the certificate authority (CA) will use to complete domain validation.
          example:
          - administrator@example.com
          - webmaster@example.com
          items: {}
        http_body:
          type: string
          description: The content that the certificate authority (CA) will expect to find at the http_url during the domain validation.
          example: ca3-574923932a82475cb8592200f1a2a23d
        http_url:
          type: string
          description: The url that will be checked during domain validation.
          example: http://app.example.com/.well-known/pki-validation/ca3-da12a1c25e7b48cf80408c6c1763b8a2.txt
        txt_name:
          type: string
          description: The hostname that the certificate authority (CA) will check for a TXT record during domain validation .
          example: _acme-challenge.app.example.com
        txt_value:
          type: string
          description: The TXT record that the certificate authority (CA) will check during domain validation.
          example: 810b7d5f01154524b961ba0cd578acc2
    access_schemas-identity-providers:
      anyOf:
      - $ref: '#/components/schemas/access_schemas-azureAD'
      - $ref: '#/components/schemas/access_schemas-centrify'
      - $ref: '#/components/schemas/access_schemas-facebook'
      - $ref: '#/components/schemas/access_schemas-github'
      - $ref: '#/components/schemas/access_schemas-google'
      - $ref: '#/components/schemas/access_schemas-google-apps'
      - $ref: '#/components/schemas/access_schemas-linkedin'
      - $ref: '#/components/schemas/access_schemas-oidc'
      - $ref: '#/components/schemas/access_schemas-okta'
      - $ref: '#/components/schemas/access_schemas-onelogin'
      - $ref: '#/components/schemas/access_schemas-pingone'
      - $ref: '#/components/schemas/access_schemas-saml'
      - $ref: '#/components/schemas/access_schemas-yandex'
    legacy-jhs_sort:
      type: array
      description: The sort order for the result set; sort fields must be included in `metrics` or `dimensions`.
      example:
      - +count
      - -bytesIngress
      items: {}
    legacy-jhs_deleted:
      type: boolean
      description: When true, indicates that the firewall rule was deleted.
      example: true
    bill-subs-api_schemas-rate-plan:
      allOf:
      - $ref: '#/components/schemas/bill-subs-api_rate-plan'
      type: object
    zones_websockets_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'off'
      - 'on'
      default: 'off'
    api-shield_p90:
      type: integer
      description: The p90 quantile of requests (in period_seconds).
      readOnly: true
    legacy-jhs_tls:
      type: string
      description: The type of TLS termination associated with the application.
      enum:
      - 'off'
      - flexible
      - full
      - strict
      example: full
    zaraz_zaraz-config-row-base:
      required:
      - id
      - createdAt
      - updatedAt
      - userId
      properties:
        createdAt:
          type: string
          format: date-time
          description: Date and time the configuration was created
        id:
          type: integer
          description: ID of the configuration
        updatedAt:
          type: string
          format: date-time
          description: Date and time the configuration was last updated
        userId:
          type: string
          description: Alpha-numeric ID of the account user who published the configuration
    tls-certificates-and-hostnames_keyless_response_single_id:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
    access_device_posture_rule:
      type: object
      title: Device Posture
      description: Enforces a device posture rule has run successfully
      required:
      - device_posture
      properties:
        device_posture:
          type: object
          required:
          - integration_uid
          properties:
            integration_uid:
              type: string
              description: The ID of a device posture integration.
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
    bill-subs-api_component_values:
      type: array
      description: The list of add-ons subscribed to.
      items:
        $ref: '#/components/schemas/bill-subs-api_component_value'
    page-shield_list-zone-connections-response:
      allOf:
      - $ref: '#/components/schemas/page-shield_api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/page-shield_connection'
          result_info:
            $ref: '#/components/schemas/page-shield_result_info'
    tls-certificates-and-hostnames_state:
      type: string
      description: State, provided by the CSR
      example: CA
      readOnly: true
    waitingroom_event_suspended:
      type: boolean
      description: Suspends or allows an event. If set to `true`, the event is ignored and traffic will be handled based on the waiting room configuration.
      default: false
    zones_hotlink_protection:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - hotlink_protection
            example: hotlink_protection
          value:
            $ref: '#/components/schemas/zones_hotlink_protection_value'
      title: Hotlink Protection
      description: When enabled, the Hotlink Protection option ensures that other sites cannot suck up your bandwidth by building pages that use images hosted on your site. Anytime a request for an image on your site hits Cloudflare, we check to ensure that it's not another site requesting them. People will still be able to download and view images from your page, but other sites won't be able to steal them for use on their own pages. (https://support.cloudflare.com/hc/en-us/articles/200170026).
    bill-subs-api_unit_price:
      type: number
      description: The unit price of the addon.
      example: 1
      readOnly: true
    logpush_logpush_job_response_single:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/logpush_logpush_job'
    zones_browser_cache_ttl:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - browser_cache_ttl
            example: browser_cache_ttl
          value:
            $ref: '#/components/schemas/zones_browser_cache_ttl_value'
      title: Browser Cache TTL
      description: Browser Cache TTL (in seconds) specifies how long Cloudflare-cached resources will remain on your visitors' computers. Cloudflare will honor any larger times specified by your server. (https://support.cloudflare.com/hc/en-us/articles/200168276).
    page-shield_update-zone-settings-response:
      properties:
        enabled:
          $ref: '#/components/schemas/page-shield_enabled'
        updated_at:
          $ref: '#/components/schemas/page-shield_updated_at'
        use_cloudflare_reporting_endpoint:
          $ref: '#/components/schemas/page-shield_use_cloudflare_reporting_endpoint'
        use_connection_url_path:
          $ref: '#/components/schemas/page-shield_use_connection_url_path'
    speed_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/speed_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/speed_messages'
          example: []
        result:
          type: object
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          example: false
    legacy-jhs_firewalluablock:
      properties:
        configuration:
          $ref: '#/components/schemas/legacy-jhs_components-schemas-configuration'
        description:
          $ref: '#/components/schemas/legacy-jhs_ua-rules_components-schemas-description'
        id:
          $ref: '#/components/schemas/legacy-jhs_ua-rules_components-schemas-id'
        mode:
          $ref: '#/components/schemas/legacy-jhs_ua-rules_components-schemas-mode'
        paused:
          $ref: '#/components/schemas/legacy-jhs_schemas-paused'
    secondary-dns_schemas-force_response:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/secondary-dns_schemas-force_result'
    waf-managed-rules_mode_allow_traditional:
      type: string
      description: When set to `on`, the current rule will be used when evaluating the request. Applies to traditional (allow) WAF rules.
      enum:
      - 'on'
      - 'off'
      example: 'on'
    load-balancing_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    rulesets_id:
      type: string
      description: Human-readable identifier of the Managed Transform.
      example: add_cf-bot-score_header
    access_schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    access_api-response-single:
      allOf:
      - $ref: '#/components/schemas/access_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    waf-managed-rules_rules_count:
      type: number
      description: The number of rules in the current rule group.
      default: 0
      example: 10
      readOnly: true
    tls-certificates-and-hostnames_components-schemas-validity_days:
      type: integer
      description: The number of days the Client Certificate will be valid after the issued_on date
      example: 3650
    tls-certificates-and-hostnames_expired_on:
      type: string
      description: Date that the Client Certificate expires
      example: '2033-02-20T23:18:00Z'
      readOnly: true
    zones_tls_1_2_only:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: Zone setting identifier.
            enum:
            - tls_1_2_only
            example: tls_1_2_only
          value:
            $ref: '#/components/schemas/zones_tls_1_2_only_value'
      title: TLS1.2 only
      description: Only allows TLS1.2.
    waitingroom_total_active_users:
      type: integer
      description: Sets the total number of active user sessions on the route at a point in time. A route is a combination of host and path on which a waiting room is available. This value is used as a baseline for the total number of active user sessions on the route. It is possible to have a situation where there are more or less active users sessions on the route based on the traffic patterns at that time around the world.
      minimum: 200
      maximum: 2147483647
    legacy-jhs_methods:
      type: array
      description: The HTTP methods to match. You can specify a subset (for example, `['POST','PUT']`) or all methods (`['_ALL_']`). This field is optional when creating a rate limit.
      example:
      - GET
      - POST
      items:
        type: string
        description: An HTTP method or `_ALL_` to indicate all methods.
        enum:
        - GET
        - POST
        - PUT
        - DELETE
        - PATCH
        - HEAD
        - _ALL_
        example: GET
    email_update_catch_all_rule_properties:
      type: object
      required:
      - actions
      - matchers
      properties:
        actions:
          $ref: '#/components/schemas/email_rule_catchall-actions'
        enabled:
          $ref: '#/components/schemas/email_rule_enabled'
        matchers:
          $ref: '#/components/schemas/email_rule_catchall-matchers'
        name:
          $ref: '#/components/schemas/email_rule_name'
    tls-certificates-and-hostnames_origin:
      type: string
      description: Your origin hostname that requests to your custom hostnames will be sent to.
      example: fallback.example.com
      maxLength: 255
    observatory_schedule_frequency:
      type: string
      description: The frequency of the test.
      enum:
      - DAILY
      - WEEKLY
      example: DAILY
    zones_vanity_name_servers:
      type: array
      description: 'An array of domains used for custom name servers. This is only

        available for Business and Enterprise plans.'
      example:
      - ns1.example.com
      - ns2.example.com
      items:
        type: string
        format: hostname
        maxLength: 253
    tls-certificates-and-hostnames_updated_at:
      type: string
      format: date-time
      description: The time when the certificate was updated.
      example: '2100-01-01T05:20:00Z'
      readOnly: true
    bill-subs-api_component-value:
      type: object
      properties:
        default:
          $ref: '#/components/schemas/bill-subs-api_default'
        name:
          $ref: '#/components/schemas/bill-subs-api_components-schemas-name'
        unit_price:
          $ref: '#/components/schemas/bill-subs-api_unit_price'
    access_ip_list_rule:
      type: object
      title: IP list
      description: Matches an IP address from a list.
      required:
      - ip_list
      properties:
        ip_list:
          type: object
          required:
          - id
          properties:
            id:
              type: string
              description: The ID of a previously created IP list.
              example: aa0a4aab-672b-4bdb-bc33-a59f1130a11f
    healthchecks_retries:
      type: integer
      description: The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately.
      default: 2
    dnssec_dnssec_multi_signer:
      type: boolean
      description: 'If true, multi-signer DNSSEC is enabled on the zone, allowing multiple

        providers to serve a DNSSEC-signed zone at the same time.

        This is required for DNSKEY records (except those automatically

        generated by Cloudflare) to be added to the zone.


        See [Multi-signer DNSSEC](https://developers.cloudflare.com/dns/dnssec/multi-signer-dnssec/) for details.'
      example: false
    cache_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    page-shield_api-response-single:
      allOf:
      - $ref: '#/components/schemas/page-shield_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: array
              items: {}
            - type: string
      type: object
    tls-certificates-and-hostnames_per_hostname_settings_response_collection:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-collection'
      - properties:
          result:
            type: array
            items:
              properties:
                created_at:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-created_at'
                hostname:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname'
                status:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status'
                updated_at:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-updated_at'
                value:
                  $ref: '#/components/schemas/tls-certificates-and-hostnames_value'
      - properties:
          result_info:
            type: object
            properties:
              count:
                example: 1
              page:
                example: 1
              per_page:
                example: 50
              total_count:
                example: 1
              total_pages:
                type: number
                description: Total pages available of results
                example: 1
    argo-analytics_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    legacy-jhs_bypass:
      type: array
      description: Criteria specifying when the current rate limit should be bypassed. You can specify that the rate limit should not apply to one or more URLs.
      items:
        type: object
        properties:
          name:
            type: string
            enum:
            - url
            example: url
          value:
            type: string
            description: The URL to bypass.
            example: api.example.com/*
    load-balancing_components-schemas-name:
      type: string
      description: The DNS hostname to associate with your Load Balancer. If this hostname already exists as a DNS record in Cloudflare's DNS, the Load Balancer will take precedence and the DNS record will not be used.
      example: www.example.com
    zones_automatic_https_rewrites_value:
      type: string
      description: 'Value of the zone setting.

        Notes: Default value depends on the zone''s plan level.'
      enum:
      - 'on'
      - 'off'
      default: 'on'
    legacy-jhs_uri_search:
      type: string
      description: A single URI to search for in the list of URLs of existing rules.
      example: /some/path
    waf-managed-rules_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/waf-managed-rules_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/waf-managed-rules_result_info'
      type: object
    zones_minify_value:
      type: object
      description: Value of the zone setting.
      default:
        css: 'off'
        html: 'off'
        js: 'off'
      properties:
        css:
          description: Automatically minify all CSS files for your website.
          enum:
          - 'on'
          - 'off'
          default: 'off'
        html:
          description: Automatically minify all HTML files for your website.
          enum:
          - 'on'
          - 'off'
          default: 'off'
        js:
          description: Automatically minify all JavaScript files for your website.
          enum:
          - 'on'
          - 'off'
          default: 'off'
    access_identity-providers_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              anyOf:
              - $ref: '#/components/schemas/access_schemas-azureAD'
              - $ref: '#/components/schemas/access_schemas-centrify'
              - $ref: '#/components/schemas/access_schemas-facebook'
              - $ref: '#/components/schemas/access_schemas-github'
              - $ref: '#/components/schemas/access_schemas-google'
              - $ref: '#/components/schemas/access_schemas-google-apps'
              - $ref: '#/components/schemas/access_schemas-linkedin'
              - $ref: '#/components/schemas/access_schemas-oidc'
              - $ref: '#/components/schemas/access_schemas-okta'
              - $ref: '#/components/schemas/access_schemas-onelogin'
              - $ref: '#/components/schemas/access_schemas-pingone'
              - $ref: '#/components/schemas/access_schemas-saml'
              - $ref: '#/components/schemas/access_schemas-yandex'
              - $ref: '#/components/schemas/access_schemas-onetimepin'
      type: object
    zones_proxy_read_timeout_value:
      type: number
      description: 'Value of the zone setting.

        Notes: Value must be between 1 and 6000'
      default: 100
    tls-certificates-and-hostnames_schemas-private_key:
      type: string
      description: The hostname certificate's private key.
      example: '--BEGIN RSA PRIVATE KEY--

        MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG

        dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn

        abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid

        tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py

        FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE

        ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb

        HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/

        axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb

        +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g

        +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv

        KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7

        9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo

        /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu

        iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9

        N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe

        VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB

        vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U

        lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR

        9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7

        mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX

        dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe

        PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS

        fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W

        qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T

        lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi

        --END RSA PRIVATE KEY--

        '
    cache_zone_cache_settings_response_single:
      allOf:
      - $ref: '#/components/schemas/cache_api-response-single'
      - properties:
          result:
            type: object
    waitingroom_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    email_email_setting_name:
      type: string
      description: Domain of your zone.
      example: example.net
      readOnly: true
    zones_hotlink_protection_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    logpush_logpull_options:
      type: string
      format: uri-reference
      description: This field is deprecated. Use `output_options` instead. Configuration string. It specifies things like requested fields and timestamp formats. If migrating from the logpull api, copy the url (full url or just the query string) of your call here, and logpush will keep on making this call for you, setting start and end times appropriately.
      example: fields=RayID,ClientIP,EdgeStartTimestamp&timestamps=rfc3339
      nullable: true
      deprecated: true
      maxLength: 4096
    tls-certificates-and-hostnames_keyless-certificate:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_base'
      type: object
    access_schemas-vnc_props:
      allOf:
      - $ref: '#/components/schemas/access_schemas-self_hosted_props'
      - properties:
          type:
            type: string
            description: The application type.
            example: vnc
    legacy-jhs_header_name:
      type: string
      description: The name of the response header to match.
      example: Cf-Cache-Status
    tls-certificates-and-hostnames_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/tls-certificates-and-hostnames_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    data-zone-analytics-api_colo_response:
      allOf:
      - $ref: '#/components/schemas/data-zone-analytics-api_api-response-single'
      - properties:
          query:
            $ref: '#/components/schemas/data-zone-analytics-api_query_response'
          result:
            $ref: '#/components/schemas/data-zone-analytics-api_datacenters'
    tls-certificates-and-hostnames_validity_days:
      type: integer
      description: Validity Days selected for the order.
      enum:
      - 14
      - 30
      - 90
      - 365
    load-balancing_country_pools:
      type: object
      description: A mapping of country codes to a list of pool IDs (ordered by their failover priority) for the given country. Any country not explicitly defined will fall back to using the corresponding region_pool mapping if it exists else to default_pools.
      example:
        GB:
        - abd90f38ced07c2e2f4df50b1f61d4194
        US:
        - de90f38ced07c2e2f4df50b1f61d4194
        - 00920f38ce07c2e2f4df50b1f61d4194
    api-shield_zone_schema_validation_settings:
      type: object
      properties:
        validation_default_mitigation_action:
          $ref: '#/components/schemas/api-shield_validation_default_mitigation_action'
        validation_override_mitigation_action:
          $ref: '#/components/schemas/api-shield_validation_override_mitigation_action'
    observatory_api-response-single:
      allOf:
      - $ref: '#/components/schemas/observatory_api-response-common'
      type: object
    argo-config_patch:
      type: object
      description: Update enablement of Argo Smart Routing
      required:
      - value
      properties:
        value:
          $ref: '#/components/schemas/argo-config_value'
    access_schemas-google:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            $ref: '#/components/schemas/access_generic-oauth-config'
      type: object
      title: Google
    zones_rocket_loader_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    email_update_rule_properties:
      type: object
      required:
      - actions
      - matchers
      properties:
        actions:
          $ref: '#/components/schemas/email_rule_actions'
        enabled:
          $ref: '#/components/schemas/email_rule_enabled'
        matchers:
          $ref: '#/components/schemas/email_rule_matchers'
        name:
          $ref: '#/components/schemas/email_rule_name'
        priority:
          $ref: '#/components/schemas/email_rule_priority'
    logpush_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/logpush_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/logpush_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    legacy-jhs_schemas-configuration:
      oneOf:
      - $ref: '#/components/schemas/legacy-jhs_ip_configuration'
      - $ref: '#/components/schemas/legacy-jhs_ipv6_configuration'
      - $ref: '#/components/schemas/legacy-jhs_cidr_configuration'
      - $ref: '#/components/schemas/legacy-jhs_asn_configuration'
      - $ref: '#/components/schemas/legacy-jhs_country_configuration'
      type: object
      description: The rule configuration.
    dnssec_digest:
      type: string
      description: Digest hash.
      example: 48E939042E82C22542CB377B580DFDC52A361CEFDC72E7F9107E2B6BD9306A45
      nullable: true
      readOnly: true
    legacy-jhs_schemas-description_search:
      type: string
      description: A string to search for in the description of existing rules.
      example: endpoints
    logpush_logpush_field_response_collection:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-common'
      - properties:
          result:
            type: object
            items:
              type: object
              nullable: true
              properties:
                key:
                  type: string
                  example: value
    zones_http3_value:
      type: string
      description: Value of the HTTP3 setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    page-shield_enabled:
      type: boolean
      description: When true, indicates that Page Shield is enabled.
      example: true
    access_approval_required:
      type: boolean
      description: Requires the user to request access from an administrator at the start of each session.
      default: false
      example: true
    tls-certificates-and-hostnames_issued_on:
      type: string
      description: Date that the Client Certificate was issued by the Certificate Authority
      example: '2023-02-23T23:18:00Z'
      readOnly: true
    email_api-response-single:
      allOf:
      - $ref: '#/components/schemas/email_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    tls-certificates-and-hostnames_components-schemas-certificate_authority:
      type: string
      description: The Certificate Authority that Total TLS certificates will be issued through.
      enum:
      - google
      - lets_encrypt
      example: google
    tls-certificates-and-hostnames_schemas-identifier:
      type: string
      description: Keyless certificate identifier tag.
      example: 4d2844d2ce78891c34d0b6c0535a291e
      readOnly: true
      maxLength: 32
    argo-config_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    zones_automatic_https_rewrites:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - automatic_https_rewrites
            example: automatic_https_rewrites
          value:
            $ref: '#/components/schemas/zones_automatic_https_rewrites_value'
      title: Zone Enable Automatic HTTPS Rewrites
      description: Enable the Automatic HTTPS Rewrites feature for this zone.
      default: 'off'
    rulesets_type:
      type: string
      description: The type of URL normalization performed by Cloudflare.
      example: cloudflare
    tls-certificates-and-hostnames_config:
      type: array
      items:
        $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname_certid_input'
    legacy-jhs_argo_smart_routing:
      type: boolean
      description: 'Enables Argo Smart Routing for this application.

        Notes: Only available for TCP applications with traffic_type set to "direct".'
      default: false
      example: true
    healthchecks_status:
      type: string
      description: The current status of the origin server according to the health check.
      enum:
      - unknown
      - healthy
      - unhealthy
      - suspended
      example: healthy
      readOnly: true
    data-zone-analytics-api_bandwidth_by_colo:
      type: object
      description: Breakdown of totals for bandwidth in the form of bytes.
      properties:
        all:
          type: integer
          description: The total number of bytes served within the time frame.
        cached:
          type: integer
          description: The number of bytes that were cached (and served) by Cloudflare.
        uncached:
          type: integer
          description: The number of bytes that were fetched and served from the origin server.
    bot-management_using_latest_model:
      type: boolean
      description: 'A read-only field that indicates whether the zone currently is running the latest ML model.

        '
      example: true
      readOnly: true
    access_timestamp:
      type: string
      format: date-time
      example: '2014-01-01T05:20:00.12345Z'
      readOnly: true
    legacy-jhs_ref:
      type: string
      description: A short reference tag. Allows you to select related firewall rules.
      example: MIR-31
      maxLength: 50
    legacy-jhs_id:
      type: string
      description: Identifier of a recommedation result.
      example: ssl_recommendation
    legacy-jhs_content_type:
      type: string
      description: 'The content type of the body. Must be one of the following: `text/plain`, `text/xml`, or `application/json`.'
      example: text/xml
      maxLength: 50
    tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled:
      type: boolean
      description: Indicates whether hostname-level authenticated origin pulls is enabled. A null value voids the association.
      example: true
      nullable: true
    dns-custom-nameservers_schemas-identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    access_id_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/access_uuid'
    waitingroom_rule_result:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/waitingroom_rule_action'
        description:
          $ref: '#/components/schemas/waitingroom_rule_description'
        enabled:
          $ref: '#/components/schemas/waitingroom_rule_enabled'
        expression:
          $ref: '#/components/schemas/waitingroom_rule_expression'
        id:
          $ref: '#/components/schemas/waitingroom_rule_id'
        last_updated:
          $ref: '#/components/schemas/waitingroom_timestamp'
        version:
          $ref: '#/components/schemas/waitingroom_rule_version'
    page-shield_get-zone-script-response:
      allOf:
      - $ref: '#/components/schemas/page-shield_script'
      - properties:
          versions:
            type: array
            example:
            - fetched_at: '2021-08-18T10:51:08Z'
              hash: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b423
              js_integrity_score: 2
            nullable: true
            items:
              $ref: '#/components/schemas/page-shield_version'
    dns-records_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/dns-records_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/dns-records_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    api-shield_auth_id_tokens:
      type: integer
      description: The total number of auth-ids seen across this calculation.
      readOnly: true
    waitingroom_json_response_enabled:
      type: boolean
      description: "Only available for the Waiting Room Advanced subscription. If `true`, requests to the waiting room with the header `Accept: application/json` will receive a JSON response object with information on the user's status in the waiting room as opposed to the configured static HTML page. This JSON response object has one property `cfWaitingRoom` which is an object containing the following fields:\n1. `inWaitingRoom`: Boolean indicating if the user is in the waiting room (always **true**).\n2. `waitTimeKnown`: Boolean indicating if the current estimated wait times are accurate. If **false**, they are not available.\n3. `waitTime`: Valid only when `waitTimeKnown` is **true**. Integer indicating the current estimated time in minutes the user will wait in the waiting room. When `queueingMethod` is **random**, this is set to `waitTime50Percentile`.\n4. `waitTime25Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 25% of users that gain entry the fastest (25th percentile).\n5. `waitTime50Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 50% of users that gain entry the fastest (50th percentile). In other words, half of the queued users are expected to let into the origin website before `waitTime50Percentile` and half are expected to be let in after it.\n6. `waitTime75Percentile`: Valid only when `queueingMethod` is **random** and `waitTimeKnown` is **true**. Integer indicating the current estimated maximum wait time for the 75% of users that gain entry the fastest (75th percentile).\n7. `waitTimeFormatted`: String displaying the `waitTime` formatted in English for users. If `waitTimeKnown` is **false**, `waitTimeFormatted` will display **unavailable**.\n8. `queueIsFull`: Boolean indicating if the waiting room's queue is currently full and not accepting new users at the moment.\n9. `queueAll`: Boolean indicating if all users will be queued in the waiting room and no one will be let into the origin website.\n10. `lastUpdated`: String displaying the timestamp as an ISO 8601 string of the user's last attempt to leave the waiting room and be let into the origin website. The user is able to make another attempt after `refreshIntervalSeconds` past this time. If the user makes a request too soon, it will be ignored and `lastUpdated` will not change.\n11. `refreshIntervalSeconds`: Integer indicating the number of seconds after `lastUpdated` until the user is able to make another attempt to leave the waiting room and be let into the origin website. When the `queueingMethod` is `reject`, there is no specified refresh time — it will always be **zero**.\n12. `queueingMethod`: The queueing method currently used by the waiting room. It is either **fifo**, **random**, **passthrough**, or **reject**.\n13. `isFIFOQueue`: Boolean indicating if the waiting room uses a FIFO (First-In-First-Out) queue.\n14. `isRandomQueue`: Boolean indicating if the waiting room uses a Random queue where users gain access randomly.\n15. `isPassthroughQueue`: Boolean indicating if the waiting room uses a passthrough queue. Keep in mind that when passthrough is enabled, this JSON response will only exist when `queueAll` is **true** or `isEventPrequeueing` is **true** because in all other cases requests will go directly to the origin.\n16. `isRejectQueue`: Boolean indicating if the waiting room uses a reject queue.\n17. `isEventActive`: Boolean indicating if an event is currently occurring. Events are able to change a waiting room's behavior during a specified period of time. For additional information, look at the event properties `prequeue_start_time`, `event_start_time`, and `event_end_time` in the documentation for creating waiting room events. Events are considered active between these start and end times, as well as during the prequeueing period if it exists.\n18. `isEventPrequeueing`: Valid only when `isEventActive` is **true**. Boolean indicating if an event is currently prequeueing users before it starts.\n19. `timeUntilEventStart`: Valid only when `isEventPrequeueing` is **true**. Integer indicating the number of minutes until the event starts.\n20. `timeUntilEventStartFormatted`: String displaying the `timeUntilEventStart` formatted in English for users. If `isEventPrequeueing` is **false**, `timeUntilEventStartFormatted` will display **unavailable**.\n21. `timeUntilEventEnd`: Valid only when `isEventActive` is **true**. Integer indicating the number of minutes until the event ends.\n22. `timeUntilEventEndFormatted`: String displaying the `timeUntilEventEnd` formatted in English for users. If `isEventActive` is **false**, `timeUntilEventEndFormatted` will display **unavailable**.\n23. `shuffleAtEventStart`: Valid only when `isEventActive` is **true**. Boolean indicating if the users in the prequeue are shuffled randomly when the event starts.\n\nAn example cURL to a waiting room could be:\n\n\tcurl -X GET \"https://example.com/waitingroom\" \\\n\t\t-H \"Accept: application/json\"\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **fifo** and no event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 0,\n\t\t\t\"waitTime50Percentile\": 0,\n\t\t\t\"waitTime75Percentile\": 0,\n\t\t\t\"waitTimeFormatted\": \"10 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"fifo\",\n\t\t\t\"isFIFOQueue\": true,\n\t\t\t\"isRandomQueue\": false,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": false,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 0,\n\t\t\t\"timeUntilEventEndFormatted\": \"unavailable\",\n\t\t\t\"shuffleAtEventStart\": false\n\t\t}\n\t}\n\nIf `json_response_enabled` is **true** and the request hits the waiting room, an example JSON response when `queueingMethod` is **random** and an event is active could be:\n\n\t{\n\t\t\"cfWaitingRoom\": {\n\t\t\t\"inWaitingRoom\": true,\n\t\t\t\"waitTimeKnown\": true,\n\t\t\t\"waitTime\": 10,\n\t\t\t\"waitTime25Percentile\": 5,\n\t\t\t\"waitTime50Percentile\": 10,\n\t\t\t\"waitTime75Percentile\": 15,\n\t\t\t\"waitTimeFormatted\": \"5 minutes to 15 minutes\",\n\t\t\t\"queueIsFull\": false,\n\t\t\t\"queueAll\": false,\n\t\t\t\"lastUpdated\": \"2020-08-03T23:46:00.000Z\",\n\t\t\t\"refreshIntervalSeconds\": 20,\n\t\t\t\"queueingMethod\": \"random\",\n\t\t\t\"isFIFOQueue\": false,\n\t\t\t\"isRandomQueue\": true,\n\t\t\t\"isPassthroughQueue\": false,\n\t\t\t\"isRejectQueue\": false,\n\t\t\t\"isEventActive\": true,\n\t\t\t\"isEventPrequeueing\": false,\n\t\t\t\"timeUntilEventStart\": 0,\n\t\t\t\"timeUntilEventStartFormatted\": \"unavailable\",\n\t\t\t\"timeUntilEventEnd\": 15,\n\t\t\t\"timeUntilEventEndFormatted\": \"15 minutes\",\n\t\t\t\"shuffleAtEventStart\": true\n\t\t}\n\t}."
      default: false
      example: false
    waf-managed-rules_mode_anomaly:
      type: string
      description: When set to `on`, the current WAF rule will be used when evaluating the request. Applies to anomaly detection WAF rules.
      enum:
      - 'on'
      - 'off'
      example: 'on'
    legacy-jhs_filter-rules-single-response:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - type: object
        required:
        - result
        properties:
          result:
            allOf:
            - $ref: '#/components/schemas/legacy-jhs_filter-rule-response'
            - type: object
              required:
              - id
              - filter
              - action
              - paused
    zones_ssl_value:
      type: string
      description: 'Value of the zone setting.

        Notes: Depends on the zone''s plan level'
      enum:
      - 'off'
      - flexible
      - full
      - strict
      default: 'off'
    legacy-jhs_waf_rewrite_action:
      description: The WAF rule action to apply.
      enum:
      - challenge
      - block
      - simulate
      - disable
      - default
    access_policy_check_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            type: object
            properties:
              app_state:
                type: object
                properties:
                  app_uid:
                    $ref: '#/components/schemas/access_uuid'
                  aud:
                    type: string
                    example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe389
                  hostname:
                    type: string
                    example: test.com
                  name:
                    type: string
                    example: Test App
                  policies:
                    type: array
                    example:
                    - decision: allow
                      exclude: []
                      include:
                      - _type: email
                        email: testuser@gmail.com
                      precedence: 0
                      require: []
                      status: Success
                    items: {}
                  status:
                    type: string
                    example: Success
              user_identity:
                type: object
                properties:
                  account_id:
                    type: string
                    example: 41ecfbb341f033e52b46742756aabb8b
                  device_sessions:
                    type: object
                    example: {}
                  email:
                    type: string
                    example: testuser@gmail.com
                  geo:
                    type: object
                    properties:
                      country:
                        type: string
                        example: US
                  iat:
                    type: integer
                  id:
                    type: string
                    example: '1164449231815010287495'
                  is_gateway:
                    type: boolean
                    example: false
                  is_warp:
                    type: boolean
                    example: false
                  name:
                    type: string
                    example: Test User
                  user_uuid:
                    $ref: '#/components/schemas/access_uuid'
                  version:
                    type: integer
    access_identity-providers_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/access_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/access_schemas-identity-providers'
    access_apps_components-schemas-name:
      type: string
      description: The name of the application.
      example: Admin Site
    zaraz_zaraz-config-response:
      allOf:
      - $ref: '#/components/schemas/zaraz_api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/zaraz_zaraz-config-return'
    legacy-jhs_schemas-mode:
      type: string
      description: The action to apply to a matched request.
      enum:
      - block
      - challenge
      - whitelist
      - js_challenge
      - managed_challenge
      example: challenge
    legacy-jhs_ip_firewall:
      type: boolean
      description: 'Enables IP Access Rules for this application.

        Notes: Only available for TCP applications.'
      example: true
    access_ca:
      type: object
      properties:
        aud:
          $ref: '#/components/schemas/access_aud'
        id:
          $ref: '#/components/schemas/access_id'
        public_key:
          $ref: '#/components/schemas/access_public_key'
    zones_ssl_recommender:
      allOf:
      - properties:
          enabled:
            $ref: '#/components/schemas/zones_ssl_recommender_enabled'
          id:
            description: Enrollment value for SSL/TLS Recommender.
            enum:
            - ssl_recommender
            example: ssl_recommender
      title: SSL/TLS Recommender
      description: Enrollment in the SSL/TLS Recommender service which tries to detect and recommend (by sending periodic emails) the most secure SSL/TLS setting your origin servers support.
    legacy-jhs_package_components-schemas-name:
      type: string
      description: The name of the WAF package.
      example: USER
      readOnly: true
    waitingroom_event_response:
      allOf:
      - $ref: '#/components/schemas/waitingroom_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/waitingroom_event_result'
    observatory_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    tls-certificates-and-hostnames_priority:
      type: number
      description: The order/priority in which the certificate will be used in a request. The higher priority will break ties across overlapping 'legacy_custom' certificates, but 'legacy_custom' certificates will always supercede 'sni_custom' certificates.
      default: 20
      example: 1
    snippets-api_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    workers_filter-no-id:
      required:
      - pattern
      - enabled
      properties:
        enabled:
          $ref: '#/components/schemas/workers_enabled'
        pattern:
          $ref: '#/components/schemas/workers_schemas-pattern'
    waitingroom_rule_action:
      type: string
      description: The action to take when the expression matches.
      enum:
      - bypass_waiting_room
      example: bypass_waiting_room
    legacy-jhs_created_on:
      type: string
      format: date-time
      description: The timestamp of when the rule was created.
      example: '2014-01-01T05:20:00.12345Z'
      readOnly: true
    dns-records_dns_response_single:
      allOf:
      - $ref: '#/components/schemas/dns-records_api-response-single'
      - type: object
        properties:
          result:
            $ref: '#/components/schemas/dns-records_dns-record'
    waf-managed-rules_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/waf-managed-rules_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/waf-managed-rules_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    tls-certificates-and-hostnames_client-certificates_components-schemas-status:
      description: Client Certificates may be active or revoked, and the pending_reactivation or pending_revocation represent in-progress asynchronous transitions
      enum:
      - active
      - pending_reactivation
      - pending_revocation
      - revoked
      example: active
    access_schemas-self_hosted_props:
      type: object
      title: Self Hosted Application
      required:
      - type
      - domain
      properties:
        allowed_idps:
          $ref: '#/components/schemas/access_allowed_idps'
        app_launcher_visible:
          $ref: '#/components/schemas/access_app_launcher_visible'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/access_schemas-auto_redirect_to_identity'
        cors_headers:
          $ref: '#/components/schemas/access_cors_headers'
        custom_deny_message:
          $ref: '#/components/schemas/access_custom_deny_message'
        custom_deny_url:
          $ref: '#/components/schemas/access_schemas-custom_deny_url'
        domain:
          $ref: '#/components/schemas/access_components-schemas-domain'
        enable_binding_cookie:
          $ref: '#/components/schemas/access_enable_binding_cookie'
        http_only_cookie_attribute:
          $ref: '#/components/schemas/access_http_only_cookie_attribute'
        logo_url:
          $ref: '#/components/schemas/access_logo_url'
        name:
          $ref: '#/components/schemas/access_apps_components-schemas-name'
        same_site_cookie_attribute:
          $ref: '#/components/schemas/access_same_site_cookie_attribute'
        service_auth_401_redirect:
          $ref: '#/components/schemas/access_service_auth_401_redirect'
        session_duration:
          $ref: '#/components/schemas/access_schemas-session_duration'
        skip_interstitial:
          $ref: '#/components/schemas/access_skip_interstitial'
        type:
          type: string
          description: The application type.
          example: self_hosted
    legacy-jhs_dns:
      type: object
      description: The name and type of DNS record for the Spectrum application.
      properties:
        name:
          $ref: '#/components/schemas/legacy-jhs_dns_name'
        type:
          $ref: '#/components/schemas/legacy-jhs_dns_type'
    observatory_lighthouse_state:
      type: string
      description: The state of the Lighthouse report.
      enum:
      - RUNNING
      - COMPLETE
      - FAILED
      example: COMPLETE
    tls-certificates-and-hostnames_hostname_certid_object:
      properties:
        cert_id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        cert_status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status'
        cert_updated_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_updated_at'
        cert_uploaded_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-uploaded_on'
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate'
        created_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-created_at'
        enabled:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-enabled'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-expires_on'
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-hostname'
        issuer:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_issuer'
        serial_number:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_serial_number'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_signature'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status'
        updated_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_updated_at'
    dns_dns_analytics_api_report_bytime:
      allOf:
      - $ref: '#/components/schemas/dns_dns_analytics_api_result'
      - required:
        - time_intervals
        - query
        - data
        properties:
          data:
            items:
              required:
              - metrics
              properties:
                metrics:
                  type: array
                  description: Array with one item per requested metric. Each item is an array of values, broken down by time interval.
                  items:
                    type: array
                    description: Nominal metric values, broken down by time interval.
                    items: {}
                    properties:
                      items:
                        type: number
                        description: Nominal metric value.
          query:
            type: object
            required:
            - time_delta
            properties:
              time_delta:
                $ref: '#/components/schemas/dns_dns_analytics_api_time_delta'
          time_intervals:
            type: array
            description: 'Array of time intervals in the response data. Each interval is represented as an array containing two values: the start time, and the end time.

              '
            items:
              type: array
              description: Array with exactly two items, representing the start and end time (respectively) of this time interval.
              items:
                type: string
                format: date-time
                description: Time value.
                example: '2023-11-11T12:00:00Z'
    legacy-jhs_components-schemas-configuration:
      type: object
      description: The configuration object for the current rule.
      properties:
        target:
          type: string
          description: The configuration target for this rule. You must set the target to `ua` for User Agent Blocking rules.
          example: ua
        value:
          type: string
          description: The exact user agent string to match. This value will be compared to the received `User-Agent` HTTP header value.
          example: Mozilla/5.0 (Macintosh; Intel Mac OS X 10_12_5) AppleWebKit/603.2.4 (KHTML, like Gecko) Version/10.1.1 Safari/603.2.4
    tls-certificates-and-hostnames_certificate_analyze_response:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            type: object
    access_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/access_messages'
        messages:
          $ref: '#/components/schemas/access_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    workers_script_name:
      type: string
      description: Name of the script, used in URLs and route configuration.
      example: this-is_my_script-01
      pattern: ^[a-z0-9_][a-z0-9-_]*$
    waf-managed-rules_name:
      type: string
      description: The name of the rule group.
      example: Project Honey Pot
      readOnly: true
    healthchecks_interval:
      type: integer
      description: The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations.
      default: 60
    access_public_key:
      type: string
      description: The public key to add to your SSH server configuration.
      example: ecdsa-sha2-nistp256 xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxx/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx= open-ssh-ca@cloudflareaccess.org
      readOnly: true
    zones_pagerule_response_collection:
      allOf:
      - $ref: '#/components/schemas/zones_schemas-api-response-common'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/zones_page-rule'
    tls-certificates-and-hostnames_policy:
      type: string
      description: 'Specify the policy that determines the region where your private key will be held locally. HTTPS connections to any excluded data center will still be fully encrypted, but will incur some latency while Keyless SSL is used to complete the handshake with the nearest allowed data center. Any combination of countries, specified by their two letter country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements) can be chosen, such as ''country: IN'', as well as ''region: EU'' which refers to the EU region. If there are too few data centers satisfying the policy, it will be rejected.'
      example: '(country: US) or (region: EU)'
    data-zone-analytics-api_datacenters:
      type: array
      title: Analytics data by datacenter
      description: A breakdown of all dashboard analytics data by co-locations. This is limited to Enterprise zones only.
      items:
        type: object
        properties:
          colo_id:
            type: string
            description: The airport code identifer for the co-location.
            example: SFO
          timeseries:
            $ref: '#/components/schemas/data-zone-analytics-api_timeseries_by_colo'
          totals:
            $ref: '#/components/schemas/data-zone-analytics-api_totals_by_colo'
    rulesets_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    legacy-jhs_dimensions:
      type: array
      description: "Can be used to break down the data by given attributes. Options are: \n\nDimension                 | Name                            | Example\n--||--\nevent                     | Connection Event                | connect, progress, disconnect, originError, clientFiltered\nappID                     | Application ID                  | 40d67c87c6cd4b889a4fd57805225e85\ncoloName                  | Colo Name                       | SFO\nipVersion                 | IP version used by the client   | 4, 6."
      example:
      - event
      - appID
      items:
        type: string
        enum:
        - event
        - appID
        - coloName
        - ipVersion
    api-shield_collection_response_paginated:
      allOf:
      - $ref: '#/components/schemas/api-shield_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/api-shield_api-shield'
    dns-records_search:
      type: string
      description: 'Allows searching in multiple properties of a DNS record simultaneously. This parameter is intended for human users, not automation. Its exact behavior is intentionally left unspecified and is subject to change in the future. This parameter works independently of the `match` setting. For automated searches, please use the other available parameters.

        '
      example: www.cloudflare.com
    access_response_collection_hostnames:
      allOf:
      - $ref: '#/components/schemas/access_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/access_settings'
    api-shield_endpoint:
      type: string
      format: uri-template
      description: 'The endpoint which can contain path parameter templates in curly braces, each will be replaced from left to right with {varN}, starting with {var1}, during insertion. This will further be Cloudflare-normalized upon insertion. See: https://developers.cloudflare.com/rules/normalization/how-it-works/.'
      example: /api/v1/users/{var1}
      maxLength: 4096
      pattern: ^/.*$
    api-shield_operation_mitigation_action:
      type: string
      description: "When set, this applies a mitigation action to this operation\n\n  - `log` log request when request does not conform to schema for this operation\n  - `block` deny access to the site when request does not conform to schema for this operation\n  - `none` will skip mitigation for this operation\n  - `null` indicates that no operation level mitigation is in place, see Zone Level Schema Validation Settings for mitigation action that will be applied\n"
      enum:
      - log
      - block
      - none
      - null
      example: block
      nullable: true
    zones_pseudo_ipv4_value:
      type: string
      description: Value of the Pseudo IPv4 setting.
      enum:
      - 'off'
      - add_header
      - overwrite_header
      default: 'off'
    cache_regional_tiered_cache_response_value:
      properties:
        result:
          allOf:
          - $ref: '#/components/schemas/cache_regional_tiered_cache'
          - required:
            - value
            properties:
              value:
                $ref: '#/components/schemas/cache_regional_tiered_cache'
    healthchecks_query_healthcheck:
      type: object
      required:
      - name
      - address
      properties:
        address:
          $ref: '#/components/schemas/healthchecks_address'
        check_regions:
          $ref: '#/components/schemas/healthchecks_check_regions'
        consecutive_fails:
          $ref: '#/components/schemas/healthchecks_consecutive_fails'
        consecutive_successes:
          $ref: '#/components/schemas/healthchecks_consecutive_successes'
        description:
          $ref: '#/components/schemas/healthchecks_description'
        http_config:
          $ref: '#/components/schemas/healthchecks_http_config'
        interval:
          $ref: '#/components/schemas/healthchecks_interval'
        name:
          $ref: '#/components/schemas/healthchecks_name'
        retries:
          $ref: '#/components/schemas/healthchecks_retries'
        suspended:
          $ref: '#/components/schemas/healthchecks_suspended'
        tcp_config:
          $ref: '#/components/schemas/healthchecks_tcp_config'
        timeout:
          $ref: '#/components/schemas/healthchecks_timeout'
        type:
          $ref: '#/components/schemas/healthchecks_type'
    cache_cache_reserve_value:
      type: string
      description: Value of the Cache Reserve zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'off'
    tls-certificates-and-hostnames_certificate_authority:
      type: string
      description: The Certificate Authority that will issue the certificate
      enum:
      - digicert
      - google
      - lets_encrypt
      example: google
    dweb-config_web3-hostname:
      type: object
      properties:
        created_on:
          $ref: '#/components/schemas/dweb-config_timestamp'
        description:
          $ref: '#/components/schemas/dweb-config_description'
        dnslink:
          $ref: '#/components/schemas/dweb-config_dnslink'
        id:
          $ref: '#/components/schemas/dweb-config_identifier'
        modified_on:
          $ref: '#/components/schemas/dweb-config_timestamp'
        name:
          $ref: '#/components/schemas/dweb-config_name'
        status:
          $ref: '#/components/schemas/dweb-config_status'
        target:
          $ref: '#/components/schemas/dweb-config_target'
    legacy-jhs_schemas-ref:
      type: string
      description: A short reference tag. Allows you to select related filters.
      example: FIL-100
      maxLength: 50
    access_schemas-facebook:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            $ref: '#/components/schemas/access_generic-oauth-config'
      type: object
      title: Facebook
    api-shield_schema_response_discovery:
      allOf:
      - $ref: '#/components/schemas/api-shield_api-response-single'
      - properties:
          result:
            type: object
            properties:
              schemas:
                type: array
                items:
                  $ref: '#/components/schemas/api-shield_openapi'
              timestamp:
                $ref: '#/components/schemas/api-shield_timestamp'
    cache-purge_File:
      type: string
      example: http://www.example.com/css/styles.css
    healthchecks_tcp_config:
      type: object
      description: Parameters specific to TCP health check.
      nullable: true
      properties:
        method:
          type: string
          description: The TCP connection method to use for the health check.
          enum:
          - connection_established
          default: connection_established
        port:
          type: integer
          description: Port number to connect to for the health check. Defaults to 80.
          default: 80
    zones_mobile_redirect:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: Identifier of the zone setting.
            enum:
            - mobile_redirect
            example: mobile_redirect
          value:
            $ref: '#/components/schemas/zones_mobile_redirect_value'
      title: Mobile Redirect
      description: Automatically redirect visitors on mobile devices to a mobile-optimized subdomain. Refer to [Understanding Cloudflare Mobile Redirect](https://support.cloudflare.com/hc/articles/200168336) for more information.
    waitingroom_rule_expression:
      type: string
      description: Criteria defining when there is a match for the current rule.
      example: ip.src in {10.20.30.40}
    observatory_labeled_region:
      type: object
      description: A test region with a label.
      properties:
        label:
          type: string
          example: Iowa, USA
        value:
          $ref: '#/components/schemas/observatory_region'
    logpush_instant_logs_job_response_single:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/logpush_instant_logs_job'
    tls-certificates-and-hostnames_organization:
      type: string
      description: Organization, provided by the CSR
      example: Organization
      readOnly: true
    tls-certificates-and-hostnames_uploaded_on:
      type: string
      format: date-time
      description: When the certificate was uploaded to Cloudflare.
      example: '2014-01-01T05:20:00Z'
      readOnly: true
    email_rule_name:
      type: string
      description: Routing rule name.
      example: Send to user@example.net rule.
      maxLength: 256
    api-shield_default_response:
      allOf:
      - $ref: '#/components/schemas/api-shield_api-response-single'
    bill-subs-api_schemas-name:
      type: string
      description: The plan name.
      example: Free Plan
      readOnly: true
      maxLength: 80
    tls-certificates-and-hostnames_name_write:
      type: string
      description: The keyless SSL name.
      example: example.com Keyless SSL
      maxLength: 180
    rulesets_RulesetPhase:
      type: string
      title: Phase
      description: The phase of the ruleset.
      enum:
      - ddos_l4
      - ddos_l7
      - http_config_settings
      - http_custom_errors
      - http_log_custom_fields
      - http_ratelimit
      - http_request_cache_settings
      - http_request_dynamic_redirect
      - http_request_firewall_custom
      - http_request_firewall_managed
      - http_request_late_transform
      - http_request_origin
      - http_request_redirect
      - http_request_sanitize
      - http_request_sbfm
      - http_request_select_configuration
      - http_request_transform
      - http_response_compression
      - http_response_firewall_managed
      - http_response_headers_transform
      - magic_transit
      - magic_transit_ids_managed
      - magic_transit_managed
      example: http_request_firewall_custom
    legacy-jhs_package_components-schemas-identifier:
      type: string
      description: The unique identifier of a WAF package.
      example: a25a9a7e9c00afc1fb2e0245519d725b
      readOnly: true
      maxLength: 32
    legacy-jhs_deleted-filter:
      required:
      - id
      - deleted
      properties:
        deleted:
          $ref: '#/components/schemas/legacy-jhs_deleted'
        id:
          $ref: '#/components/schemas/legacy-jhs_filters_components-schemas-id'
    workers_route-no-id:
      required:
      - pattern
      properties:
        pattern:
          $ref: '#/components/schemas/workers_pattern'
        script:
          $ref: '#/components/schemas/workers_script_name'
    legacy-jhs_app_id:
      type: string
      description: Application identifier.
      example: ea95132c15732412d22c1476fa83f27a
      readOnly: true
      maxLength: 32
    custom-pages_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    observatory_lighthouse_error_code:
      type: string
      description: The error code of the Lighthouse result.
      enum:
      - NOT_REACHABLE
      - DNS_FAILURE
      - NOT_HTML
      - LIGHTHOUSE_TIMEOUT
      - UNKNOWN
      example: NOT_REACHABLE
    logpush_instant_logs_job:
      type: object
      nullable: true
      properties:
        destination_conf:
          $ref: '#/components/schemas/logpush_schemas-destination_conf'
        fields:
          $ref: '#/components/schemas/logpush_fields'
        filter:
          $ref: '#/components/schemas/logpush_filter'
        sample:
          $ref: '#/components/schemas/logpush_sample'
        session_id:
          $ref: '#/components/schemas/logpush_session_id'
    zones_type:
      type: string
      description: 'A full zone implies that DNS is hosted with Cloudflare. A partial zone is

        typically a partner-hosted zone or a CNAME setup.

        '
      enum:
      - full
      - partial
      - secondary
      example: full
    tls-certificates-and-hostnames_hosts:
      type: array
      items:
        type: string
        description: The valid hosts for the certificates.
        example: example.com
        readOnly: true
        maxLength: 253
    page-shield_fetched_at:
      type: string
      description: The timestamp of when the script was last fetched.
      nullable: true
    bill-subs-api_frequency:
      type: string
      description: How often the subscription is renewed automatically.
      enum:
      - weekly
      - monthly
      - quarterly
      - yearly
      example: monthly
    rulesets_available:
      type: boolean
      description: When true, the Managed Transform is available in the current Cloudflare plan.
      example: true
    zones_ssl:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - ssl
            example: ssl
          value:
            $ref: '#/components/schemas/zones_ssl_value'
      title: SSL
      description: 'SSL encrypts your visitor''s connection and safeguards credit card numbers and other personal data to and from your website. SSL can take up to 5 minutes to fully activate. Requires Cloudflare active on your root domain or www domain. Off: no SSL between the visitor and Cloudflare, and no SSL between Cloudflare and your web server  (all HTTP traffic). Flexible: SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, but no SSL between Cloudflare and your web server. You don''t need to have an SSL cert on your web server, but your vistors will still see the site as being HTTPS enabled. Full:  SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have your own SSL cert or self-signed cert at the very least. Full (Strict): SSL between the visitor and Cloudflare -- visitor sees HTTPS on your site, and SSL between Cloudflare and your web server. You''ll need to have a valid SSL certificate installed on your web server. This certificate must be signed by a certificate authority, have an expiration date in the future, and respond for the request domain name (hostname). (https://support.cloudflare.com/hc/en-us/articles/200170416).'
    bill-subs-api_duration:
      type: number
      description: The duration of the plan subscription.
      example: 1
    tls-certificates-and-hostnames_schemas-certificate:
      type: string
      description: The zone's SSL certificate or SSL certificate and intermediate(s).
      example: --BEGIN CERTIFICATE-- MIIDtTCCAp2gAwIBAgIJAM15n7fdxhRtMA0GCSqGSIb3DQEBBQUAMEUxCzAJBgNV BAYTAlVTMRMwEQYDVQQIEwpTb21lLVN0YXRlMSEwHwYDVQQKExhJbnRlcm5ldCBX aWRnaXRzIFB0eSBMdGQwHhcNMTQwMzExMTkyMTU5WhcNMTQwNDEwMTkyMTU5WjBF MQswCQYDVQQGEwJVUzETMBEGA1UECBMKU29tZS1TdGF0ZTEhMB8GA1UEChMYSW50 ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIB CgKCAQEAvq3sKsHpeduJHimOK+fvQdKsI8z8A05MZyyLp2/R/GE8FjNv+hkVY1WQ LIyTNNQH7CJecE1nbTfo8Y56S7x/rhxC6/DJ8MIulapFPnorq46KU6yRxiM0MQ3N nTJHlHA2ozZta6YBBfVfhHWl1F0IfNbXCLKvGwWWMbCx43OfW6KTkbRnE6gFWKuO fSO5h2u5TaWVuSIzBvYs7Vza6m+gtYAvKAJV2nSZ+eSEFPDo29corOy8+huEOUL8 5FAw4BFPsr1TlrlGPFitduQUHGrSL7skk1ESGza0to3bOtrodKei2s9bk5MXm7lZ qI+WZJX4Zu9+mzZhc9pCVi8r/qlXuQIDAQABo4GnMIGkMB0GA1UdDgQWBBRvavf+ sWM4IwKiH9X9w1vl6nUVRDB1BgNVHSMEbjBsgBRvavf+sWM4IwKiH9X9w1vl6nUV RKFJpEcwRTELMAkGA1UEBhMCVVMxEzARBgNVBAgTClNvbWUtU3RhdGUxITAfBgNV BAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZIIJAM15n7fdxhRtMAwGA1UdEwQF MAMBAf8wDQYJKoZIhvcNAQEFBQADggEBABY2ZzBaW0dMsAAT7tPJzrVWVzQx6KU4 UEBLudIlWPlkAwTnINCWR/8eNjCCmGA4heUdHmazdpPa8RzwOmc0NT1NQqzSyktt vTqb4iHD7+8f9MqJ9/FssCfTtqr/Qst/hGH4Wmdf1EJ/6FqYAAb5iRlPgshFZxU8 uXtA8hWn6fK6eISD9HBdcAFToUvKNZ1BIDPvh9f95Ine8ar6yGd56TUNrHR8eHBs ESxz5ddVR/oWRysNJ+aGAyYqHS8S/ttmC7r4XCAHqXptkHPCGRqkAhsterYhd4I8 /cBzejUobNCjjHFbtkAL/SjxZOLW+pNkZwfeYdM8iPkD54Uua1v2tdw= --END CERTIFICATE--
    bot-management_optimize_wordpress:
      type: boolean
      description: Whether to optimize Super Bot Fight Mode protections for Wordpress.
      example: true
    zones_h2_prioritization_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      - custom
      default: 'off'
    rulesets_LogRule:
      allOf:
      - $ref: '#/components/schemas/rulesets_Rule'
      - title: Log rule
        properties:
          action:
            enum:
            - log
          action_parameters:
            enum:
            - {}
          description:
            example: Log when the IP address is not 1.1.1.1
    healthchecks_http_config:
      type: object
      description: Parameters specific to an HTTP or HTTPS health check.
      nullable: true
      properties:
        allow_insecure:
          type: boolean
          description: Do not validate the certificate when the health check uses HTTPS.
          default: false
        expected_body:
          type: string
          description: A case-insensitive sub-string to look for in the response body. If this string is not found, the origin will be marked as unhealthy.
          example: success
        expected_codes:
          type: array
          description: The expected HTTP response codes (e.g. "200") or code ranges (e.g. "2xx" for all codes starting with 2) of the health check.
          default: '200'
          example:
          - 2xx
          - '302'
          nullable: true
          items:
            type: string
        follow_redirects:
          type: boolean
          description: Follow redirects if the origin returns a 3xx status code.
          default: false
        header:
          type: object
          description: The HTTP request headers to send in the health check. It is recommended you set a Host header by default. The User-Agent header cannot be overridden.
          example:
            Host:
            - example.com
            X-App-ID:
            - abc123
          nullable: true
        method:
          type: string
          description: The HTTP method to use for the health check.
          enum:
          - GET
          - HEAD
          default: GET
        path:
          type: string
          description: The endpoint path to health check against.
          default: /
          example: /health
        port:
          type: integer
          description: Port number to connect to for the health check. Defaults to 80 if type is HTTP or 443 if type is HTTPS.
          default: 80
    zones_polish_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'off'
      - lossless
      - lossy
      default: 'off'
    waitingroom_zone_settings:
      type: object
      properties:
        search_engine_crawler_bypass:
          $ref: '#/components/schemas/waitingroom_search_engine_crawler_bypass'
    zones_zone_settings_response_single:
      allOf:
      - $ref: '#/components/schemas/zones_api-response-common'
      - properties:
          result:
            type: object
    api-shield_schema_upload_log_event:
      type: object
      required:
      - code
      properties:
        code:
          type: integer
          description: Code that identifies the event that occurred.
          example: 28
        locations:
          type: array
          description: JSONPath location(s) in the schema where these events were encountered.  See [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) for JSONPath specification.
          items:
            type: string
            description: JSONPath location in the schema where these events were encountered.  See [https://goessner.net/articles/JsonPath/](https://goessner.net/articles/JsonPath/) for JSONPath specification.
            example: .paths["/user/{username}"].put
        message:
          type: string
          description: Diagnostic message that describes the event.
          example: 'unsupported media type: application/octet-stream'
    legacy-jhs_app_id_param:
      type: string
      description: Comma-delimited list of Spectrum Application Id(s). If provided, the response will be limited to Spectrum Application Id(s) that match.
      example: ea95132c15732412d22c1476fa83f27a,d122c5f4bb71e25cc9e86ab43b142e2f
    load-balancing_location_strategy:
      type: object
      description: Controls location-based steering for non-proxied requests. See `steering_policy` to learn how steering is affected.
      properties:
        mode:
          type: string
          description: 'Determines the authoritative location when ECS is not preferred, does not exist in the request, or its GeoIP lookup is unsuccessful.

            - `"pop"`: Use the Cloudflare PoP location.

            - `"resolver_ip"`: Use the DNS resolver GeoIP location. If the GeoIP lookup is unsuccessful, use the Cloudflare PoP location.'
          enum:
          - pop
          - resolver_ip
          default: pop
          example: resolver_ip
        prefer_ecs:
          type: string
          description: 'Whether the EDNS Client Subnet (ECS) GeoIP should be preferred as the authoritative location.

            - `"always"`: Always prefer ECS.

            - `"never"`: Never prefer ECS.

            - `"proximity"`: Prefer ECS only when `steering_policy="proximity"`.

            - `"geo"`: Prefer ECS only when `steering_policy="geo"`.'
          enum:
          - always
          - never
          - proximity
          - geo
          default: proximity
          example: always
    zones_mirage:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - mirage
            example: mirage
          value:
            $ref: '#/components/schemas/zones_mirage_value'
      title: Mirage Image Optimization
      description: 'Automatically optimize image loading for website visitors on mobile

        devices. Refer to [our blog post](http://blog.cloudflare.com/mirage2-solving-mobile-speed)

        for more information.

        '
    legacy-jhs_filters_components-schemas-description:
      type: string
      description: An informative summary of the filter.
      example: Restrict access from these browsers on this address range.
      maxLength: 500
    zones_api-response-single:
      allOf:
      - $ref: '#/components/schemas/zones_schemas-api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    access_schemas-google-apps:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            allOf:
            - $ref: '#/components/schemas/access_generic-oauth-config'
            - type: object
              properties:
                apps_domain:
                  type: string
                  description: Your companies TLD
                  example: mycompany.com
      type: object
      title: Google Workspace
    secondary-dns_api-response-single:
      allOf:
      - $ref: '#/components/schemas/secondary-dns_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
      type: object
    workers_route-response-single:
      allOf:
      - $ref: '#/components/schemas/workers_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/workers_routes'
    custom-pages_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/custom-pages_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/custom-pages_result_info'
      type: object
    bill-subs-api_schemas-frequency:
      type: string
      description: The frequency at which you will be billed for this plan.
      enum:
      - weekly
      - monthly
      - quarterly
      - yearly
      example: monthly
      readOnly: true
    bill-subs-api_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/bill-subs-api_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/bill-subs-api_result_info'
      type: object
    api-shield_operation_schema_validation_settings:
      type: object
      properties:
        mitigation_action:
          $ref: '#/components/schemas/api-shield_operation_mitigation_action'
    zones_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    legacy-jhs_package_components-schemas-description:
      type: string
      description: A summary of the purpose/function of the WAF package.
      example: 'null'
      readOnly: true
    dns_dns_analytics_api_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/dns_dns_analytics_api_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/dns_dns_analytics_api_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    legacy-jhs_threshold:
      type: number
      description: The threshold that will trigger the configured mitigation action. Configure this value along with the `period` property to establish a threshold per period.
      example: 60
      minimum: 1
    waf-managed-rules_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    zones_tls_client_auth:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - tls_client_auth
            example: tls_client_auth
          value:
            $ref: '#/components/schemas/zones_tls_client_auth_value'
      title: TLS Client Authentication
      description: TLS Client Auth requires Cloudflare to connect to your origin server using a client certificate (Enterprise Only).
    api-shield_collection_response:
      allOf:
      - $ref: '#/components/schemas/api-shield_api-response-collection'
      - properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/api-shield_api-shield'
              - properties:
                  features: {}
    legacy-jhs_ip_configuration:
      title: An IP address configuration.
      properties:
        target:
          description: The configuration target. You must set the target to `ip` when specifying an IP address in the rule.
          enum:
          - ip
          example: ip
        value:
          type: string
          description: The IP address to match. This address will be compared to the IP address of incoming requests.
          example: 198.51.100.4
    email_rule_enabled:
      type: boolean
      description: Routing rule status.
      enum:
      - true
      - false
      default: true
      example: true
    custom-pages_api-response-single:
      allOf:
      - $ref: '#/components/schemas/custom-pages_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
            nullable: true
      type: object
    logpush_get_ownership_response:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            properties:
              filename:
                type: string
                example: logs/challenge-filename.txt
              message:
                type: string
                example: ''
              valid:
                type: boolean
                example: true
    cache-purge_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    waitingroom_event_name:
      type: string
      description: A unique name to identify the event. Only alphanumeric characters, hyphens and underscores are allowed.
      example: production_webinar_event
    zones_zone:
      type: object
      required:
      - id
      - name
      - development_mode
      - owner
      - account
      - meta
      - original_name_servers
      - original_registrar
      - original_dnshost
      - created_on
      - modified_on
      - activated_on
      properties:
        account:
          type: object
          description: The account the zone belongs to
          properties:
            id:
              $ref: '#/components/schemas/zones_identifier'
            name:
              type: string
              description: The name of the account
              example: Example Account Name
        activated_on:
          type: string
          format: date-time
          description: 'The last time proof of ownership was detected and the zone was made

            active'
          example: '2014-01-02T00:01:00.12345Z'
          nullable: true
          readOnly: true
        created_on:
          type: string
          format: date-time
          description: When the zone was created
          example: '2014-01-01T05:20:00.12345Z'
          readOnly: true
        development_mode:
          type: number
          description: 'The interval (in seconds) from when development mode expires

            (positive integer) or last expired (negative integer) for the

            domain. If development mode has never been enabled, this value is 0.'
          example: 7200
          readOnly: true
        id:
          $ref: '#/components/schemas/zones_identifier'
        meta:
          type: object
          description: Metadata about the zone
          properties:
            cdn_only:
              type: boolean
              description: The zone is only configured for CDN
              example: true
            custom_certificate_quota:
              type: integer
              description: Number of Custom Certificates the zone can have
              example: 1
            dns_only:
              type: boolean
              description: The zone is only configured for DNS
              example: true
            foundation_dns:
              type: boolean
              description: The zone is setup with Foundation DNS
              example: true
            page_rule_quota:
              type: integer
              description: Number of Page Rules a zone can have
              example: 100
            phishing_detected:
              type: boolean
              description: The zone has been flagged for phishing
              example: false
            step:
              type: integer
              example: 2
        modified_on:
          type: string
          format: date-time
          description: When the zone was last modified
          example: '2014-01-01T05:20:00.12345Z'
          readOnly: true
        name:
          type: string
          description: The domain name
          example: example.com
          maxLength: 253
          pattern: ^([a-zA-Z0-9][\-a-zA-Z0-9]*\.)+[\-a-zA-Z0-9]{2,20}$
        original_dnshost:
          type: string
          description: DNS host at the time of switching to Cloudflare
          example: NameCheap
          nullable: true
          readOnly: true
          maxLength: 50
        original_name_servers:
          type: array
          description: 'Original name servers before moving to Cloudflare

            Notes: Is this only available for full zones?'
          example:
          - ns1.originaldnshost.com
          - ns2.originaldnshost.com
          nullable: true
          readOnly: true
          items:
            type: string
            format: hostname
        original_registrar:
          type: string
          description: Registrar for the domain at the time of switching to Cloudflare
          example: GoDaddy
          nullable: true
          readOnly: true
        owner:
          type: object
          description: The owner of the zone
          properties:
            id:
              $ref: '#/components/schemas/zones_identifier'
            name:
              type: string
              description: Name of the owner
              example: Example Org
            type:
              type: string
              description: The type of owner
              example: organization
        vanity_name_servers:
          type: array
          description: An array of domains used for custom name servers. This is only available for Business and Enterprise plans.
          example:
          - ns1.example.com
          - ns2.example.com
          items:
            type: string
            format: hostname
            maxLength: 253
    dns_dns_analytics_api_query:
      type: object
      required:
      - dimensions
      - metrics
      - since
      - until
      - limit
      properties:
        dimensions:
          type: array
          description: Array of dimension names.
          example:
          - responseCode
          - queryName
          items:
            type: string
            description: Dimension name.
            example: responseCode
        filters:
          $ref: '#/components/schemas/dns_dns_analytics_api_filters'
        limit:
          $ref: '#/components/schemas/dns_dns_analytics_api_limit'
        metrics:
          type: array
          description: Array of metric names.
          example:
          - queryCount
          - responseTimeAvg
          items:
            type: string
            description: Metric name.
            example: queries
        since:
          $ref: '#/components/schemas/dns_dns_analytics_api_since'
        sort:
          type: array
          description: Array of dimensions to sort by, where each dimension may be prefixed by - (descending) or + (ascending).
          example:
          - +responseCode
          - -queryName
          items:
            type: string
            description: Dimension name (may be prefixed by - (descending) or + (ascending).
            example: +responseCode
        until:
          $ref: '#/components/schemas/dns_dns_analytics_api_until'
    legacy-jhs_edge_ips:
      oneOf:
      - type: object
        properties:
          connectivity:
            type: string
            description: The IP versions supported for inbound connections on Spectrum anycast IPs.
            enum:
            - all
            - ipv4
            - ipv6
            example: all
          type:
            type: string
            description: The type of edge IP configuration specified. Dynamically allocated edge IPs use Spectrum anycast IPs in accordance with the connectivity you specify. Only valid with CNAME DNS names.
            enum:
            - dynamic
            example: dynamic
      - type: object
        properties:
          ips:
            type: array
            description: The array of customer owned IPs we broadcast via anycast for this hostname and application.
            example:
            - 192.0.2.1
            items:
              type: string
              description: Edge anycast IPs.
              example: 192.0.2.1
          type:
            type: string
            description: The type of edge IP configuration specified. Statically allocated edge IPs use customer IPs in accordance with the ips array you specify. Only valid with ADDRESS DNS names.
            enum:
            - static
            example: static
      description: The anycast edge IP configuration for the hostname of this application.
      default:
        connectivity: all
        type: dynamic
    tls-certificates-and-hostnames_expires_on:
      type: string
      format: date-time
      description: When the certificate from the authority expires.
      example: '2016-01-01T05:20:00Z'
      readOnly: true
    legacy-jhs_schemes:
      type: array
      description: The HTTP schemes to match. You can specify one scheme (`['HTTPS']`), both schemes (`['HTTP','HTTPS']`), or all schemes (`['_ALL_']`). This field is optional.
      example:
      - HTTP
      - HTTPS
      items:
        type: string
        description: An HTTP scheme or `_ALL_` to indicate all schemes.
        example: HTTPS
    snippets-api_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/snippets-api_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/snippets-api_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status:
      type: string
      description: Deployment status for the given tls setting.
      example: pending_deployment
    waitingroom_event_id:
      example: 25756b2dfe6e378a06b033b670413757
    speed_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      properties:
        errors:
          $ref: '#/components/schemas/speed_messages'
        messages:
          $ref: '#/components/schemas/speed_messages'
        success:
          type: boolean
          description: Whether the API call was successful
          example: true
    api-shield_period_seconds:
      type: integer
      description: The period over which this threshold is suggested.
      readOnly: true
    cache_variants_value:
      type: object
      description: Value of the zone setting.
      properties:
        avif:
          type: array
          description: List of strings with the MIME types of all the variants that should be served for avif.
          example:
          - image/webp
          - image/jpeg
          uniqueItems: true
          items: {}
        bmp:
          type: array
          description: List of strings with the MIME types of all the variants that should be served for bmp.
          example:
          - image/webp
          - image/jpeg
          uniqueItems: true
          items: {}
        gif:
          type: array
          description: List of strings with the MIME types of all the variants that should be served for gif.
          example:
          - image/webp
          - image/jpeg
          uniqueItems: true
          items: {}
        jp2:
          type: array
          description: List of strings with the MIME types of all the variants that should be served for jp2.
          example:
          - image/webp
          - image/avif
          uniqueItems: true
          items: {}
        jpeg:
          type: array
          description: List of strings with the MIME types of all the variants that should be served for jpeg.
          example:
          - image/webp
          - image/avif
          uniqueItems: true
          items: {}
        jpg:
          type: array
          description: List of strings with the MIME types of all the variants that should be served for jpg.
          example:
          - image/webp
          - image/avif
          uniqueItems: true
          items: {}
        jpg2:
          type: array
          description: List of strings with the MIME types of all the variants that should be served for jpg2.
          example:
          - image/webp
          - image/avif
          uniqueItems: true
          items: {}
        png:
          type: array
          description: List of strings with the MIME types of all the variants that should be served for png.
          example:
          - image/webp
          - image/avif
          uniqueItems: true
          items: {}
        tif:
          type: array
          description: List of strings with the MIME types of all the variants that should be served for tif.
          example:
          - image/webp
          - image/avif
          uniqueItems: true
          items: {}
        tiff:
          type: array
          description: List of strings with the MIME types of all the variants that should be served for tiff.
          example:
          - image/webp
          - image/avif
          uniqueItems: true
          items: {}
        webp:
          type: array
          description: List of strings with the MIME types of all the variants that should be served for webp.
          example:
          - image/jpeg
          - image/avif
          uniqueItems: true
          items: {}
    tls-certificates-and-hostnames_schemas-uploaded_on:
      type: string
      format: date-time
      description: This is the time the certificate was uploaded.
      example: '2019-10-28T18:11:23.37411Z'
    bot-management_auto_update_model:
      type: boolean
      description: Automatically update to the newest bot detection models created by Cloudflare as they are released. [Learn more.](https://developers.cloudflare.com/bots/reference/machine-learning-models#model-versions-and-release-notes)
      example: true
    tls-certificates-and-hostnames_total_tls_settings_response:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            properties:
              certificate_authority:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-certificate_authority'
              enabled:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-enabled'
              validity_days:
                $ref: '#/components/schemas/tls-certificates-and-hostnames_schemas-validity_days'
    zones_browser_cache_ttl_value:
      type: number
      description: 'Value of the zone setting.

        Notes: Setting a TTL of 0 is equivalent to selecting `Respect Existing Headers`'
      enum:
      - 0
      - 30
      - 60
      - 120
      - 300
      - 1200
      - 1800
      - 3600
      - 7200
      - 10800
      - 14400
      - 18000
      - 28800
      - 43200
      - 57600
      - 72000
      - 86400
      - 172800
      - 259200
      - 345600
      - 432000
      - 691200
      - 1382400
      - 2073600
      - 2678400
      - 5356800
      - 16070400
      - 31536000
      default: 14400
    page-shield_get-zone-settings-response:
      properties:
        enabled:
          $ref: '#/components/schemas/page-shield_enabled'
        updated_at:
          $ref: '#/components/schemas/page-shield_updated_at'
        use_cloudflare_reporting_endpoint:
          $ref: '#/components/schemas/page-shield_use_cloudflare_reporting_endpoint'
        use_connection_url_path:
          $ref: '#/components/schemas/page-shield_use_connection_url_path'
    load-balancing_fallback_pool:
      description: The pool ID to use when all other pools are detected as unhealthy.
    email_catch_all_rule_response_single:
      allOf:
      - $ref: '#/components/schemas/email_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/email_catch_all_rule'
    legacy-jhs_rule_collection_response:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/legacy-jhs_rule'
    dweb-config_content_list_details_response:
      allOf:
      - $ref: '#/components/schemas/dweb-config_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/dweb-config_content_list_details'
    email_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    access_service-tokens_components-schemas-name:
      type: string
      description: The name of the service token.
      example: CI/CD token
    legacy-jhs_components-schemas-paused:
      type: boolean
      description: When true, indicates that the firewall rule is currently paused.
      example: false
    load-balancing_api-response-single:
      allOf:
      - $ref: '#/components/schemas/load-balancing_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
              nullable: true
            - type: string
              nullable: true
      type: object
    waf-managed-rules_allowed_modes_anomaly:
      type: array
      description: Defines the available modes for the current WAF rule. Applies to anomaly detection WAF rules.
      example:
      - 'on'
      - 'off'
      readOnly: true
      items:
        $ref: '#/components/schemas/waf-managed-rules_mode_anomaly'
    load-balancing_pop_pools:
      type: object
      description: '(Enterprise only): A mapping of Cloudflare PoP identifiers to a list of pool IDs (ordered by their failover priority) for the PoP (datacenter). Any PoPs not explicitly defined will fall back to using the corresponding country_pool, then region_pool mapping if it exists else to default_pools.'
      example:
        LAX:
        - de90f38ced07c2e2f4df50b1f61d4194
        - 9290f38c5d07c2e2f4df57b1f61d4196
        LHR:
        - abd90f38ced07c2e2f4df50b1f61d4194
        - f9138c5d07c2e2f4df57b1f61d4196
        SJC:
        - 00920f38ce07c2e2f4df50b1f61d4194
    api-shield_schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-shield_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/api-shield_api-shield'
    speed_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      maxLength: 32
    access_allowed_headers:
      type: array
      description: Allowed HTTP request headers.
      items: {}
    dweb-config_content_list_details:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/dweb-config_content_list_action'
    secondary-dns_soa_serial:
      type: number
      description: The serial number of the SOA for the given zone.
      example: 2019102400
    healthchecks_suspended:
      type: boolean
      description: If suspended, no health checks are sent to the origin.
      default: false
    zones_created_on:
      type: string
      format: date-time
      description: The timestamp of when the Page Rule was created.
      example: '2014-01-01T05:20:00.12345Z'
      readOnly: true
    tls-certificates-and-hostnames_status:
      description: Status of the zone's custom SSL.
      enum:
      - active
      - expired
      - deleted
      - pending
      - initializing
      example: active
      readOnly: true
    healthchecks_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/healthchecks_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/healthchecks_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    zones_tls_1_3:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - tls_1_3
            example: tls_1_3
          value:
            $ref: '#/components/schemas/zones_tls_1_3_value'
      title: Enable TLS 1.3 value for a zone
      description: Enables Crypto TLS 1.3 feature for a zone.
      default: 'off'
    tls-certificates-and-hostnames_client-certificates_components-schemas-certificate:
      type: string
      description: The Client Certificate PEM
      example: --BEGIN CERTIFICATE--\nMIIDmDCCAoC...dhDDE\n--END CERTIFICATE--
      readOnly: true
    legacy-jhs_origin_port:
      anyOf:
      - type: integer
      - type: string
      description: 'The destination port at the origin. Only specified in conjunction with origin_dns. May use an integer to specify a single origin port, for example `1000`, or a string to specify a range of origin ports, for example `"1000-2000"`.

        Notes: If specifying a port range, the number of ports in the range must match the number of ports specified in the "protocol" field.'
      example: 22
      minimum: 1
      maximum: 65535
    data-zone-analytics-api_logs:
      anyOf:
      - type: string
      - type: object
      example: '{"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000}

        {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000}

        {"ClientIP":"192.0.2.1","RayID":"41ddf1740f67442d","EdgeStartTimestamp":1526810289280000000}'
    legacy-jhs_ua-rules_components-schemas-mode:
      description: The action to apply to a matched request.
      enum:
      - block
      - challenge
      - js_challenge
      - managed_challenge
      example: js_challenge
      maxLength: 12
    logpush_schemas-destination_conf:
      type: string
      format: uri
      description: Unique WebSocket address that will receive messages from Cloudflare’s edge.
      example: wss://logs.cloudflare.com/instant-logs/ws/sessions/99d471b1ca3c23cc8e30b6acec5db987
      maxLength: 4096
    bill-subs-api_state:
      type: string
      description: The state that the subscription is in.
      enum:
      - Trial
      - Provisioned
      - Paid
      - AwaitingPayment
      - Cancelled
      - Failed
      - Expired
      example: Paid
      readOnly: true
    tls-certificates-and-hostnames_schemas-certificateObject:
      properties:
        certificate:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-certificate'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-expires_on'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        issuer:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_issuer'
        serial_number:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_serial_number'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_signature'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-authenticated-origin-pull_components-schemas-status'
        uploaded_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-uploaded_on'
    dweb-config_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    argo-config_api-response-single:
      allOf:
      - $ref: '#/components/schemas/argo-config_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
              nullable: true
            - type: string
              nullable: true
      type: object
    logpush_name:
      type: string
      description: Optional human readable job name. Not unique. Cloudflare suggests that you set this to a meaningful string, like the domain name, to make it easier to identify your job.
      example: example.com
      nullable: true
      maxLength: 512
      pattern: ^[a-zA-Z0-9\-\.]*$
    legacy-jhs_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    dns-records_CERTRecord:
      allOf:
      - properties:
          content:
            type: string
            description: Formatted CERT content. See 'data' to set CERT properties.
            readOnly: true
          data:
            type: object
            description: Components of a CERT record.
            properties:
              algorithm:
                type: number
                description: Algorithm.
                example: 8
                minimum: 0
                maximum: 255
              certificate:
                type: string
                description: Certificate.
              key_tag:
                type: number
                description: Key Tag.
                example: 1
                minimum: 0
                maximum: 65535
              type:
                type: number
                description: Type.
                example: 9
                minimum: 0
                maximum: 65535
          name:
            $ref: '#/components/schemas/dns-records_name'
          type:
            type: string
            description: Record type.
            enum:
            - CERT
            example: CERT
      - $ref: '#/components/schemas/dns-records_base'
      title: CERT Record
      required:
      - type
      - name
      - data
    logpush_instant_logs_job_response_collection:
      allOf:
      - $ref: '#/components/schemas/logpush_api-response-common'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/logpush_instant_logs_job'
    logpush_enabled:
      type: boolean
      description: Flag that indicates if the job is enabled.
      example: false
    load-balancing_load-balancer_components-schemas-identifier:
      type: string
      example: 699d98642c564d2e855e9661899b7252
    api-shield_api-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-shield_api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/api-shield_result_info'
      type: object
    legacy-jhs_asn_configuration:
      title: An ASN configuration.
      properties:
        target:
          description: The configuration target. You must set the target to `asn` when specifying an Autonomous System Number (ASN) in the rule.
          enum:
          - asn
          example: asn
        value:
          type: string
          description: The AS number to match.
          example: AS12345
    tls-certificates-and-hostnames_enabled:
      type: boolean
      description: Whether or not the Keyless SSL is on or off.
      example: false
      readOnly: true
    api-shield_api_discovery_state:
      type: string
      description: "State of operation in API Discovery\n  * `review` - Operation is not saved into API Shield Endpoint Management\n  * `saved` - Operation is saved into API Shield Endpoint Management\n  * `ignored` - Operation is marked as ignored\n"
      enum:
      - review
      - saved
      - ignored
    waf-managed-rules_mode_deny_traditional:
      type: string
      description: The action that the current WAF rule will perform when triggered. Applies to traditional (deny) WAF rules.
      enum:
      - default
      - disable
      - simulate
      - block
      - challenge
      example: block
    speed_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    legacy-jhs_firewall-rules_components-schemas-priority:
      type: number
      description: The priority of the rule. Optional value used to define the processing order. A lower number indicates a higher priority. If not provided, rules with a defined priority will be processed before rules without a priority.
      example: 50
      minimum: 0
      maximum: 2147483647
    tls-certificates-and-hostnames_custom-certificate:
      type: object
      required:
      - id
      - hosts
      - issuer
      - signature
      - status
      - bundle_method
      - zone_id
      - uploaded_on
      - modified_on
      - expires_on
      - priority
      properties:
        bundle_method:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_bundle_method'
        expires_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_expires_on'
        geo_restrictions:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_geo_restrictions'
        hosts:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hosts'
        id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
        issuer:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_issuer'
        keyless_server:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_keyless-certificate'
        modified_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_modified_on'
        policy:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_policy'
        priority:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_priority'
        signature:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_signature'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_status'
        uploaded_on:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_uploaded_on'
        zone_id:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_identifier'
    legacy-jhs_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-collection'
      - properties:
          result:
            type: array
            items:
              type: object
    zones_sha1_support_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'off'
      - 'on'
      default: 'off'
    dnssec_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    rulesets_request_model:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/rulesets_enabled'
        id:
          $ref: '#/components/schemas/rulesets_id'
    dns-records_MXRecord:
      allOf:
      - properties:
          content:
            type: string
            format: hostname
            description: A valid mail server hostname.
            example: mx.example.com
          name:
            $ref: '#/components/schemas/dns-records_name'
          priority:
            $ref: '#/components/schemas/dns-records_priority'
          type:
            type: string
            description: Record type.
            enum:
            - MX
            example: MX
      - $ref: '#/components/schemas/dns-records_base'
      title: MX Record
      required:
      - type
      - name
      - content
      - priority
    load-balancing_session_affinity_ttl:
      type: number
      description: 'Time, in seconds, until a client''s session expires after being created. Once the expiry time has been reached, subsequent requests may get sent to a different origin server. The accepted ranges per `session_affinity` policy are:

        - `"cookie"` / `"ip_cookie"`: The current default of 23 hours will be used unless explicitly set. The accepted range of values is between [1800, 604800].

        - `"header"`: The current default of 1800 seconds will be used unless explicitly set. The accepted range of values is between [30, 3600]. Note: With session affinity by header, sessions only expire after they haven''t been used for the number of seconds specified.'
      example: 1800
    bot-management_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/bot-management_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/bot-management_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    zaraz_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/zaraz_messages'
        messages:
          $ref: '#/components/schemas/zaraz_messages'
        success:
          type: boolean
          description: Whether the API call was successful
          example: true
    bill-subs-api_api-response-single:
      allOf:
      - $ref: '#/components/schemas/bill-subs-api_api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
              nullable: true
            - type: string
              nullable: true
      type: object
    access_external_evaluation_rule:
      type: object
      title: External Evaluation
      description: Create Allow or Block policies which evaluate the user based on custom criteria.
      required:
      - external_evaluation
      properties:
        external_evaluation:
          type: object
          required:
          - evaluate_url
          - keys_url
          properties:
            evaluate_url:
              type: string
              description: The API endpoint containing your business logic.
              example: https://eval.example.com
            keys_url:
              type: string
              description: The API endpoint containing the key that Access uses to verify that the response came from your API.
              example: https://eval.example.com/keys
    legacy-jhs_description_search:
      type: string
      description: A string to search for in the description of existing rules.
      example: abusive
    access_schemas-app_launcher_props:
      allOf:
      - $ref: '#/components/schemas/access_schemas-feature_app_props'
      - properties:
          domain:
            example: authdomain.cloudflareaccess.com
            readOnly: true
          name:
            default: App Launcher
            example: App Launcher
            readOnly: true
          type:
            type: string
            description: The application type.
            example: app_launcher
    access_result_info:
      type: object
      properties:
        count:
          type: number
          description: Total number of results for the requested service
          example: 1
        page:
          type: number
          description: Current page within paginated list of results
          example: 1
        per_page:
          type: number
          description: Number of results per page of results
          example: 20
        total_count:
          type: number
          description: Total results available without any search parameters
          example: 2000
    legacy-jhs_schemas-cidr_configuration:
      title: An IP address range configuration.
      properties:
        target:
          description: The configuration target. You must set the target to `ip_range` when specifying an IP address range in the Zone Lockdown rule.
          enum:
          - ip_range
          example: ip_range
        value:
          type: string
          description: The IP address range to match. You can only use prefix lengths `/16` and `/24`.
          example: 198.51.100.4/16
    access_schemas-session_duration:
      type: string
      description: 'The amount of time that tokens issued for this application will be valid. Must be in the format `300ms` or `2h45m`. Valid time units are: ns, us (or µs), ms, s, m, h.'
      default: 24h
      example: 24h
    dweb-config_content_list_entry_create_request:
      type: object
      required:
      - type
      - content
      properties:
        content:
          $ref: '#/components/schemas/dweb-config_content_list_entry_content'
        description:
          $ref: '#/components/schemas/dweb-config_content_list_entry_description'
        type:
          $ref: '#/components/schemas/dweb-config_content_list_entry_type'
    dnssec_messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    secondary-dns_api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/secondary-dns_messages'
        messages:
          $ref: '#/components/schemas/secondary-dns_messages'
        result:
          anyOf:
          - type: object
          - type: array
            items: {}
          - type: string
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - true
          example: true
    tls-certificates-and-hostnames_verification_type:
      type: string
      description: Method of verification.
      enum:
      - cname
      - meta tag
      example: cname
    load-balancing_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/load-balancing_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/load-balancing_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    dweb-config_target:
      type: string
      description: Target gateway of the hostname.
      enum:
      - ethereum
      - ipfs
      - ipfs_universal_path
      example: ipfs
    zones_target:
      oneOf:
      - $ref: '#/components/schemas/zones_url_target'
      description: A request condition target.
      required:
      - target
      - constraint
    waf-managed-rules_allowed_modes_allow_traditional:
      type: array
      description: Defines the available modes for the current WAF rule.
      example:
      - 'on'
      - 'off'
      readOnly: true
      items:
        $ref: '#/components/schemas/waf-managed-rules_mode_allow_traditional'
    zones_polish:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - polish
            example: polish
          value:
            $ref: '#/components/schemas/zones_polish_value'
      title: Polish Image Optimization
      description: 'Removes metadata and compresses your images for faster page load times. Basic (Lossless): Reduce the size of PNG, JPEG, and GIF files - no impact on visual quality. Basic + JPEG (Lossy): Further reduce the size of JPEG files for faster image loading. Larger JPEGs are converted to progressive images, loading a lower-resolution image first and ending in a higher-resolution version. Not recommended for hi-res photography sites.'
    zaraz_identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    zones_max_upload_value:
      type: number
      description: 'Value of the zone setting.

        Notes: The size depends on the plan level of the zone. (Enterprise = 500, Business = 200, Pro = 100, Free = 100)'
      enum:
      - 100
      - 200
      - 500
      default: 100
    api-shield_schema_upload_details_warnings_only:
      type: object
      properties:
        warnings:
          type: array
          description: Diagnostic warning events that occurred during processing. These events are non-critical errors found within the schema.
          items:
            $ref: '#/components/schemas/api-shield_schema_upload_log_event'
    api-shield_validation_override_mitigation_action:
      type: string
      description: "When set, this overrides both zone level and operation level mitigation actions.\n\n  - `none` will skip running schema validation entirely for the request\n  - `null` indicates that no override is in place\n"
      enum:
      - none
      - null
      example: disable_override
      nullable: true
    email_rule_catchall-matcher:
      type: object
      description: Matcher for catch-all routing rule.
      required:
      - type
      properties:
        type:
          type: string
          description: Type of matcher. Default is 'all'.
          enum:
          - all
          example: all
    healthchecks_name:
      type: string
      description: A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed.
      example: server-1
    access_include:
      type: array
      description: Rules evaluated with an OR logical operator. A user needs to meet only one of the Include rules.
      items:
        $ref: '#/components/schemas/access_rule'
    dnssec_key_tag:
      type: number
      description: Code for key tag.
      example: 42
      nullable: true
      readOnly: true
    dnssec_modified_on:
      type: string
      format: date-time
      description: When DNSSEC was last modified.
      example: '2014-01-01T05:20:00Z'
      nullable: true
      readOnly: true
    observatory_lighthouse_report:
      type: object
      description: The Lighthouse report.
      properties:
        cls:
          type: number
          description: Cumulative Layout Shift.
          example: 100
        deviceType:
          $ref: '#/components/schemas/observatory_device_type'
        error:
          type: object
          properties:
            code:
              $ref: '#/components/schemas/observatory_lighthouse_error_code'
            detail:
              type: string
              description: Detailed error message.
              example: 'Details: net::ERR_CONNECTION_CLOSED'
            finalDisplayedUrl:
              type: string
              description: The final URL displayed to the user.
              example: example.com
        fcp:
          type: number
          description: First Contentful Paint.
          example: 100
        jsonReportUrl:
          type: string
          description: The URL to the full Lighthouse JSON report.
        lcp:
          type: number
          description: Largest Contentful Paint.
          example: 100
        performanceScore:
          type: number
          description: The Lighthouse performance score.
          example: 90
        si:
          type: number
          description: Speed Index.
          example: 100
        state:
          $ref: '#/components/schemas/observatory_lighthouse_state'
        tbt:
          type: number
          description: Total Blocking Time.
          example: 100
        ttfb:
          type: number
          description: Time To First Byte.
          example: 100
        tti:
          type: number
          description: Time To Interactive.
          example: 100
    access_uuid:
      type: string
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      readOnly: true
      maxLength: 36
    tls-certificates-and-hostnames_zone-authenticated-origin-pull_components-schemas-enabled:
      type: boolean
      description: Indicates whether zone-level authenticated origin pulls is enabled.
      example: true
    access_schemas-apps:
      anyOf:
      - allOf:
        - $ref: '#/components/schemas/access_basic_app_response_props'
        - $ref: '#/components/schemas/access_schemas-self_hosted_props'
        type: object
        title: Self Hosted Application
      - allOf:
        - $ref: '#/components/schemas/access_basic_app_response_props'
        - $ref: '#/components/schemas/access_schemas-saas_props'
        type: object
        title: SaaS Application
      - allOf:
        - $ref: '#/components/schemas/access_basic_app_response_props'
        - $ref: '#/components/schemas/access_schemas-ssh_props'
        type: object
        title: Browser SSH Application
      - allOf:
        - $ref: '#/components/schemas/access_basic_app_response_props'
        - $ref: '#/components/schemas/access_schemas-vnc_props'
        type: object
        title: Browser VNC Application
      - allOf:
        - $ref: '#/components/schemas/access_basic_app_response_props'
        - $ref: '#/components/schemas/access_schemas-app_launcher_props'
        type: object
        title: App Launcher Application
      - allOf:
        - $ref: '#/components/schemas/access_basic_app_response_props'
        - $ref: '#/components/schemas/access_schemas-warp_props'
        type: object
        title: Device Enrollment Permissions Application
      - allOf:
        - $ref: '#/components/schemas/access_basic_app_response_props'
        - $ref: '#/components/schemas/access_schemas-biso_props'
        type: object
        title: Browser Isolation Permissions Application
      - allOf:
        - $ref: '#/components/schemas/access_basic_app_response_props'
        - $ref: '#/components/schemas/access_schemas-bookmark_props'
        type: object
        title: Bookmark application
      type: object
    zones_advanced_ddos:
      allOf:
      - $ref: '#/components/schemas/zones_base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - advanced_ddos
            example: advanced_ddos
          value:
            $ref: '#/components/schemas/zones_advanced_ddos_value'
      title: Advanced DDoS Protection
      description: Advanced protection from Distributed Denial of Service (DDoS) attacks on your website. This is an uneditable value that is 'on' in the case of Business and Enterprise zones.
    waitingroom_host:
      type: string
      description: The host name to which the waiting room will be applied (no wildcards). Please do not include the scheme (http:// or https://). The host and path combination must be unique.
      example: shop.example.com
    tls-certificates-and-hostnames_ssl_universal_settings_response:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_universal'
    tls-certificates-and-hostnames_certificate_pack_response_single:
      allOf:
      - $ref: '#/components/schemas/tls-certificates-and-hostnames_api-response-single'
      - type: object
        properties:
          result:
            type: object
    dns-records_dns_response_import_scan:
      allOf:
      - $ref: '#/components/schemas/dns-records_api-response-single'
      - type: object
        properties:
          result:
            type: object
            properties:
              recs_added:
                type: number
                description: Number of DNS records added.
                example: 5
              total_records_parsed:
                type: number
                description: Total number of DNS records parsed.
                example: 5
          timing:
            type: object
            properties:
              end_time:
                type: string
                format: date-time
                description: When the file parsing ended.
                example: '2014-03-01T12:20:01Z'
              process_time:
                type: number
                description: Processing time of the file in seconds.
                example: 1
              start_time:
                type: string
                format: date-time
                description: When the file parsing started.
                example: '2014-03-01T12:20:00Z'
    tls-certificates-and-hostnames_ssl:
      oneOf:
      - type: object
        properties:
          bundle_method:
            type: string
            description: A ubiquitous bundle has the highest probability of being verified everywhere, even by clients using outdated or unusual trust stores. An optimal bundle uses the shortest chain and newest intermediates. And the force bundle verifies the chain, but does not otherwise modify it.
            enum:
            - ubiquitous
            - optimal
            - force
            default: ubiquitous
            example: ubiquitous
          certificate_authority:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_certificate_authority'
          custom_certificate:
            type: string
            description: If a custom uploaded certificate is used.
            example: --BEGIN CERTIFICATE--\nMIIFJDCCBAygAwIBAgIQD0ifmj/Yi5NP/2gdUySbfzANBgkqhkiG9w0BAQsFADBN\nMQswCQYDVQQGEwJVUzEVMBMGA1UEChMMRGlnaUNlcnQgSW5jMScwJQYDVQQDEx5E...SzSHfXp5lnu/3V08I72q1QNzOCgY1XeL4GKVcj4or6cT6tX6oJH7ePPmfrBfqI/O\nOeH8gMJ+FuwtXYEPa4hBf38M5eU5xWG7\n--END CERTIFICATE--\n
          custom_csr_id:
            type: string
            description: The identifier for the Custom CSR that was used.
            example: 7b163417-1d2b-4c84-a38a-2fb7a0cd7752
          custom_key:
            type: string
            description: The key for a custom uploaded certificate.
            example: '--BEGIN RSA PRIVATE KEY--

              MIIEowIBAAKCAQEAwQHoetcl9+5ikGzV6cMzWtWPJHqXT3wpbEkRU9Yz7lgvddmG

              dtcGbg/1CGZu0jJGkMoppoUo4c3dts3iwqRYmBikUP77wwY2QGmDZw2FvkJCJlKn

              abIRuGvBKwzESIXgKk2016aTP6/dAjEHyo6SeoK8lkIySUvK0fyOVlsiEsCmOpid

              tnKX/a+50GjB79CJH4ER2lLVZnhePFR/zUOyPxZQQ4naHf7yu/b5jhO0f8fwt+py

              FxIXjbEIdZliWRkRMtzrHOJIhrmJ2A1J7iOrirbbwillwjjNVUWPf3IJ3M12S9pE

              ewooaeO2izNTERcG9HzAacbVRn2Y2SWIyT/18QIDAQABAoIBACbhTYXBZYKmYPCb

              HBR1IBlCQA2nLGf0qRuJNJZg5iEzXows/6tc8YymZkQE7nolapWsQ+upk2y5Xdp/

              axiuprIs9JzkYK8Ox0r+dlwCG1kSW+UAbX0bQ/qUqlsTvU6muVuMP8vZYHxJ3wmb

              +ufRBKztPTQ/rYWaYQcgC0RWI20HTFBMxlTAyNxYNWzX7RKFkGVVyB9RsAtmcc8g

              +j4OdosbfNoJPS0HeIfNpAznDfHKdxDk2Yc1tV6RHBrC1ynyLE9+TaflIAdo2MVv

              KLMLq51GqYKtgJFIlBRPQqKoyXdz3fGvXrTkf/WY9QNq0J1Vk5ERePZ54mN8iZB7

              9lwy/AkCgYEA6FXzosxswaJ2wQLeoYc7ceaweX/SwTvxHgXzRyJIIT0eJWgx13Wo

              /WA3Iziimsjf6qE+SI/8laxPp2A86VMaIt3Z3mJN/CqSVGw8LK2AQst+OwdPyDMu

              iacE8lj/IFGC8mwNUAb9CzGU3JpU4PxxGFjS/eMtGeRXCWkK4NE+G08CgYEA1Kp9

              N2JrVlqUz+gAX+LPmE9OEMAS9WQSQsfCHGogIFDGGcNf7+uwBM7GAaSJIP01zcoe

              VAgWdzXCv3FLhsaZoJ6RyLOLay5phbu1iaTr4UNYm5WtYTzMzqh8l1+MFFDl9xDB

              vULuCIIrglM5MeS/qnSg1uMoH2oVPj9TVst/ir8CgYEAxrI7Ws9Zc4Bt70N1As+U

              lySjaEVZCMkqvHJ6TCuVZFfQoE0r0whdLdRLU2PsLFP+q7qaeZQqgBaNSKeVcDYR

              9B+nY/jOmQoPewPVsp/vQTCnE/R81spu0mp0YI6cIheT1Z9zAy322svcc43JaWB7

              mEbeqyLOP4Z4qSOcmghZBSECgYACvR9Xs0DGn+wCsW4vze/2ei77MD4OQvepPIFX

              dFZtlBy5ADcgE9z0cuVB6CiL8DbdK5kwY9pGNr8HUCI03iHkW6Zs+0L0YmihfEVe

              PG19PSzK9CaDdhD9KFZSbLyVFmWfxOt50H7YRTTiPMgjyFpfi5j2q348yVT0tEQS

              fhRqaQKBgAcWPokmJ7EbYQGeMbS7HC8eWO/RyamlnSffdCdSc7ue3zdVJxpAkQ8W

              qu80pEIF6raIQfAf8MXiiZ7auFOSnHQTXUbhCpvDLKi0Mwq3G8Pl07l+2s6dQG6T

              lv6XTQaMyf6n1yjzL+fzDrH3qXMxHMO/b13EePXpDMpY7HQpoLDi

              --END RSA PRIVATE KEY--

              '
          expires_on:
            type: string
            format: date-time
            description: The time the custom certificate expires on.
            example: '2021-02-06T18:11:23.531995Z'
          hosts:
            type: array
            description: A list of Hostnames on a custom uploaded certificate.
            example:
            - app.example.com
            - '*.app.example.com'
            items: {}
          id:
            type: string
            description: Custom hostname SSL identifier tag.
            example: 0d89c70d-ad9f-4843-b99f-6cc0252067e9
            minLength: 36
            maxLength: 36
          issuer:
            type: string
            description: The issuer on a custom uploaded certificate.
            example: DigiCertInc
          method:
            description: Domain control validation (DCV) method used for this hostname.
            enum:
            - http
            - txt
            - email
            example: txt
          serial_number:
            type: string
            description: The serial number on a custom uploaded certificate.
            example: '6743787633689793699141714808227354901'
          settings:
            $ref: '#/components/schemas/tls-certificates-and-hostnames_sslsettings'
          signature:
            type: string
            description: The signature on a custom uploaded certificate.
            example: SHA256WithRSA
          status:
            description: Status of the hostname's SSL certificates.
            enum:
            - initializing
            - pending_validation
            - deleted
            - pending_issuance
            - pending_deployment
            - pending_deletion
            - pending_expiration
            - expired
            - active
            - initializing_timed_out
            - validation_timed_out
            - issuance_timed_out
            - deployment_timed_out
            - deletion_timed_out
            - pending_cleanup
            - staging_deployment
            - staging_active
            - deactivating
            - inactive
            - backup_issued
            - holding_deployment
            example: pending_validation
            readOnly: true
          type:
            description: Level of validation to be used for this hostname. Domain validation (dv) must be used.
            enum:
            - dv
            example: dv
            readOnly: true
          uploaded_on:
            type: string
            format: date-time
            description: The time the custom certificate was uploaded.
            example: '2020-02-06T18:11:23.531995Z'
          validation_errors:
            type: array
            description: Domain validation errors that have been received by the certificate authority (CA).
            items:
              type: object
              properties:
                message:
                  type: string
                  description: A domain validation error.
                  example: SERVFAIL looking up CAA for app.example.com
          validation_records:
            type: array
            items:
              $ref: '#/components/schemas/tls-certificates-and-hostnames_validation_record'
          wildcard:
            type: boolean
            description: Indicates whether the certificate covers a wildcard.
            example: false
      type: object
      description: SSL properties for the custom hostname.
    legacy-jhs_api-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/legacy-jhs_messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/legacy-jhs_messages'
          example: []
        result:
          type: object
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    rulesets_Rule:
      type: object
      title: Rule
      required:
      - version
      - last_updated
      properties:
        action:
          $ref: '#/components/schemas/rulesets_RuleAction'
        action_parameters:
          type: object
          title: Action parameters
          description: The parameters configuring the rule's action.
        categories:
          type: array
          title: Categories
          description: The categories of the rule.
          example:
          - directory-traversal
          - header
          uniqueItems: true
          readOnly: true
          minItems: 1
          items:
            $ref: '#/components/schemas/rulesets_RuleCategory'
        description:
          type: string
          title: Description
          description: An informative description of the rule.
          default: ''
        enabled:
          allOf:
          - $ref: '#/components/schemas/rulesets_RuleEnabled'
          - default: true
        expression:
          type: string
          title: Expression
          description: The expression defining which traffic will match the rule.
          example: ip.src ne 1.1.1.1
          minLength: 1
        id:
          $ref: '#/components/schemas/rulesets_RuleId'
        last_updated:
          type: string
          title: Last updated
          format: date-time
          description: The timestamp of when the rule was last modified.
          example: '2000-01-01T00:00:00.000000Z'
          readOnly: true
        logging:
          type: object
          title: Logging
          description: An object configuring the rule's logging behavior.
          required:
          - enabled
          properties:
            enabled:
              type: boolean
              title: Enabled
              description: Whether to generate a log when the rule matches.
              example: true
        ref:
          type: string
          title: Ref
          description: The reference of the rule (the rule ID by default).
          example: my_ref
          minLength: 1
        version:
          type: string
          title: Version
          description: The version of the rule.
          example: '1'
          readOnly: true
          pattern: ^[0-9]+$
    dns_dns_analytics_api_filters:
      type: string
      description: Segmentation filter in 'attribute operator value' format.
      example: responseCode==NOERROR,queryType==A
    legacy-jhs_package:
      oneOf:
      - $ref: '#/components/schemas/legacy-jhs_package_definition'
      - $ref: '#/components/schemas/legacy-jhs_anomaly_package'
      type: object
    api-shield_openapi:
      type: object
      description: A OpenAPI 3.0.0 compliant schema.
      example:
        info:
          title: OpenAPI JSON schema for www.example.com
          version: '1.0'
        openapi: 3.0.0
        paths:
          '... Further paths ...': {}
          /api/v1/users/{var1}:
            get:
              parameters:
              - in: path
                name: var1
                required: true
                schema:
                  type: string
        servers:
        - url: www.example.com
    access_schemas-linkedin:
      allOf:
      - $ref: '#/components/schemas/access_schemas-identity-provider'
      - type: object
        properties:
          config:
            $ref: '#/components/schemas/access_generic-oauth-config'
      type: object
      title: LinkedIn
    legacy-jhs_filter-rules-single-response-delete:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-single'
      - type: object
        required:
        - result
        properties:
          result:
            allOf:
            - $ref: '#/components/schemas/legacy-jhs_filter-rule-response'
            - type: object
              required:
              - id
    bill-subs-api_default:
      type: number
      description: The default amount allocated.
      example: 5
    zones_server_side_exclude_value:
      type: string
      description: Value of the zone setting.
      enum:
      - 'on'
      - 'off'
      default: 'on'
    legacy-jhs_filter-rules-response-collection-delete:
      allOf:
      - $ref: '#/components/schemas/legacy-jhs_api-response-collection'
      - type: object
        required:
        - result
        properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/legacy-jhs_filter-rule-response'
              - type: object
                required:
                - id
    zones_zone_settings_response_collection:
      allOf:
      - $ref: '#/components/schemas/zones_api-response-common'
      - properties:
          result:
            type: array
            items:
              anyOf:
              - $ref: '#/components/schemas/zones_0rtt'
              - $ref: '#/components/schemas/zones_advanced_ddos'
              - $ref: '#/components/schemas/zones_always_online'
              - $ref: '#/components/schemas/zones_always_use_https'
              - $ref: '#/components/schemas/zones_automatic_https_rewrites'
              - $ref: '#/components/schemas/zones_brotli'
              - $ref: '#/components/schemas/zones_browser_cache_ttl'
              - $ref: '#/components/schemas/zones_browser_check'
              - $ref: '#/components/schemas/zones_cache_level'
              - $ref: '#/components/schemas/zones_challenge_ttl'
              - $ref: '#/components/schemas/zones_ciphers'
              - $ref: '#/components/schemas/zones_cname_flattening'
              - $ref: '#/components/schemas/zones_development_mode'
              - $ref: '#/components/schemas/zones_early_hints'
              - $ref: '#/components/schemas/zones_edge_cache_ttl'
              - $ref: '#/components/schemas/zones_email_obfuscation'
              - $ref: '#/components/schemas/zones_h2_prioritization'
              - $ref: '#/components/schemas/zones_hotlink_protection'
              - $ref: '#/components/schemas/zones_http2'
              - $ref: '#/components/schemas/zones_http3'
              - $ref: '#/components/schemas/zones_image_resizing'
              - $ref: '#/components/schemas/zones_ip_geolocation'
              - $ref: '#/components/schemas/zones_ipv6'
              - $ref: '#/components/schemas/zones_max_upload'
              - $ref: '#/components/schemas/zones_min_tls_version'
              - $ref: '#/components/schemas/zones_minify'
              - $ref: '#/components/schemas/zones_mirage'
              - $ref: '#/components/schemas/zones_mobile_redirect'
              - $ref: '#/components/schemas/zones_nel'
              - $ref: '#/components/schemas/zones_opportunistic_encryption'
              - $ref: '#/components/schemas/zones_opportunistic_onion'
              - $ref: '#/components/schemas/zones_orange_to_orange'
              - $ref: '#/components/schemas/zones_origin_error_page_pass_thru'
              - $ref: '#/components/schemas/zones_polish'
              - $ref: '#/components/schemas/zones_prefetch_preload'
              - $ref: '#/components/schemas/zones_proxy_read_timeout'
              - $ref: '#/components/schemas/zones_pseudo_ipv4'
              - $ref: '#/components/schemas/zones_response_buffering'
              - $ref: '#/components/schemas/zones_rocket_loader'
              - $ref: '#/components/schemas/zones_schemas-automatic_platform_optimization'
              - $ref: '#/components/schemas/zones_security_header'
              - $ref: '#/components/schemas/zones_security_level'
              - $ref: '#/components/schemas/zones_server_side_exclude'
              - $ref: '#/components/schemas/zones_sha1_support'
              - $ref: '#/components/schemas/zones_sort_query_string_for_cache'
              - $ref: '#/components/schemas/zones_ssl'
              - $ref: '#/components/schemas/zones_ssl_recommender'
              - $ref: '#/components/schemas/zones_tls_1_2_only'
              - $ref: '#/components/schemas/zones_tls_1_3'
              - $ref: '#/components/schemas/zones_tls_client_auth'
              - $ref: '#/components/schemas/zones_true_client_ip_header'
              - $ref: '#/components/schemas/zones_waf'
              - $ref: '#/components/schemas/zones_webp'
              - $ref: '#/components/schemas/zones_websockets'
    api-shield_api-shield:
      allOf:
      - $ref: '#/components/schemas/api-shield_operation'
    tls-certificates-and-hostnames_settingObject:
      properties:
        created_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-created_at'
        hostname:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-hostname'
        status:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_hostname-tls-settings_components-schemas-status'
        updated_at:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_components-schemas-updated_at'
        value:
          $ref: '#/components/schemas/tls-certificates-and-hostnames_value'
    tls-certificates-and-hostnames_brand_check:
      type: boolean
      description: Certificate Authority is manually reviewing the order.
      example: false
    rulesets_SkipRule:
      allOf:
      - $ref: '#/components/schemas/rulesets_Rule'
      - title: Skip rule
        properties:
          action:
            enum:
            - skip
          action_parameters:
            example:
              ruleset: current
            properties:
              phases:
                type: array
                title: Phases
                description: A list of phases to skip the execution of. This option is incompatible with the ruleset and rulesets options.
                uniqueItems: true
                minItems: 1
                items:
                  allOf:
                  - $ref: '#/components/schemas/rulesets_RulesetPhase'
                  - description: A phase to skip the execution of.
              products:
                type: array
                title: Products
                description: A list of legacy security products to skip the execution of.
                uniqueItems: true
                minItems: 1
                items:
                  type: string
                  title: Product
                  description: The name of a legacy security product to skip the execution of.
                  enum:
                  - bic
                  - hot
                  - rateLimit
                  - securityLevel
                  - uaBlock
                  - waf
                  - zoneLockdown
              rules:
                type: object
                title: Rules
                description: A mapping of ruleset IDs to a list of rule IDs in that ruleset to skip the execution of. This option is incompatible with the ruleset option.
                example:
                  4814384a9e5d4991b9815dcfc25d2f1f:
                  - 8ac8bc2a661e475d940980f9317f28e1
                minProperties: 1
              ruleset:
                type: string
                title: Ruleset
                description: A ruleset to skip the execution of. This option is incompatible with the rulesets, rules and phases options.
                enum:
                - current
              rulesets:
                type: array
                title: Rulesets
                description: A list of ruleset IDs to skip the execution of. This option is incompatible with the ruleset and phases options.
                uniqueItems: true
                minItems: 1
                items:
                  allOf:
                  - $ref: '#/components/schemas/rulesets_RulesetId'
                  - title: Ruleset
                    description: The ID of a ruleset to skip the execution of.
                    example: 4814384a9e5d4991b9815dcfc25d2f1f
            minProperties: 1
          description:
            example: Skip the current ruleset when the IP address is not 1.1.1.1
    dweb-config_name:
      type: string
      description: The hostname that will point to the target gateway via CNAME.
      example: gateway.example.com
      readOnly: true
      maxLength: 255
  examples:
    cache_dummy_error_response:
      value:
        errors:
        - code: 12345
          message: Some error message
        messages: []
        result: null
        success: false
    cache_origin_max_http_version_2:
      value:
        errors: []
        messages: []
        result:
          editable: true
          id: origin_max_http_version
          value: '2'
        success: true
    cache_cache_reserve_off:
      value:
        errors: []
        messages: []
        result:
          editable: true
          id: cache_reserve
          value: 'off'
        success: true
    cache_cache_reserve_clear_rejected_cr_on:
      value:
        errors:
        - code: 1152
          message: Turn off Cache Reserve sync to proceed with deletion.
        messages: []
        result: null
        success: false
    cache_cache_reserve_clear_completed:
      value:
        errors: []
        messages: []
        result:
          end_ts: '2023-10-02T12:00:00.12345Z'
          id: cache_reserve_clear
          start_ts: '2023-10-02T10:00:00.12345Z'
          state: Completed
        success: true
    cache_cache_reserve_clear_in_progress:
      value:
        errors: []
        messages: []
        result:
          id: cache_reserve_clear
          start_ts: '2023-10-02T10:00:00.12345Z'
          state: In-progress
        success: true
    cache_cache_reserve_denied_clearing:
      value:
        errors:
        - code: 1153
          message: Cache Reserve cannot be enabled because a deletion is already in progress.
        messages: []
        result: null
        success: false
    cache_cache_reserve_clear_not_found:
      value:
        errors:
        - code: 1142
          message: Unable to retrieve cache_reserve_clear setting value. The zone setting does not exist because you never performed a Cache Reserve Clear operation.
        messages: []
        result: null
        success: false
  parameters:
    api-shield_parameters-operation_id:
      name: operation_id
      in: path
      description: Identifier for the discovered operation
      required: true
      schema:
        $ref: '#/components/schemas/api-shield_uuid'
    api-shield_host_parameter:
      name: host
      in: query
      schema:
        type: array
        description: Filter results to only include the specified hosts.
        uniqueItems: true
        items:
          type: string
          example: api.cloudflare.com
    api-shield_method_parameter:
      name: method
      in: query
      schema:
        type: array
        description: Filter results to only include the specified HTTP methods.
        uniqueItems: true
        items:
          type: string
          example: GET
    api-shield_page:
      name: page
      in: query
      description: Page number of paginated results.
      schema:
        default: 1
        minimum: 1
    api-shield_api_discovery_state_parameter:
      name: state
      in: query
      description: "Filter results to only include discovery results in a particular state. States are as follows\n  * `review` - Discovered operations that are not saved into API Shield Endpoint Management\n  * `saved` - Discovered operations that are already saved into API Shield Endpoint Management\n  * `ignored` - Discovered operations that have been marked as ignored\n"
      schema:
        $ref: '#/components/schemas/api-shield_api_discovery_state'
    api-shield_order_parameter:
      name: order
      in: query
      schema:
        type: string
        description: Field to order by
        enum:
        - host
        - method
        - endpoint
        - traffic_stats.requests
        - traffic_stats.last_updated
        example: method
    api-shield_api_discovery_origin_parameter:
      name: origin
      in: query
      description: "Filter results to only include discovery results sourced from a particular discovery engine\n  * `ML` - Discovered operations that were sourced using ML API Discovery\n  * `SessionIdentifier` - Discovered operations that were sourced using Session Identifier API Discovery\n"
      schema:
        $ref: '#/components/schemas/api-shield_api_discovery_origin'
    api-shield_operation_id:
      name: operation_id
      in: path
      description: Identifier for the operation
      required: true
      schema:
        type: string
        format: uuid
        readOnly: true
        maxLength: 36
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
    api-shield_zone_id:
      name: zone_id
      in: path
      required: true
      schema:
        $ref: '#/components/schemas/api-shield_identifier'
    api-shield_direction_parameter:
      name: direction
      in: query
      schema:
        type: string
        description: Direction to order results.
        enum:
        - asc
        - desc
        example: desc
    api-shield_diff_parameter:
      name: diff
      in: query
      schema:
        type: boolean
        description: When `true`, only return API Discovery results that are not saved into API Shield Endpoint Management
    api-shield_schema_id:
      name: schema_id
      in: path
      description: Identifier for the schema-ID
      required: true
      schema:
        type: string
        format: uuid
        readOnly: true
        maxLength: 36
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
    api-shield_omit_source:
      name: omit_source
      in: query
      description: Omit the source-files of schemas and only retrieve their meta-data.
      schema:
        type: boolean
        default: false
    api-shield_per_page:
      name: per_page
      in: query
      description: Maximum number of results per page.
      schema:
        default: 20
        minimum: 5
        maximum: 50
    api-shield_endpoint_parameter:
      name: endpoint
      in: query
      schema:
        type: string
        description: Filter results to only include endpoints containing this pattern.
        example: /api/v1
    api-shield_operation_feature_parameter:
      name: feature
      in: query
      description: Add feature(s) to the results. The feature name that is given here corresponds to the resulting feature object. Have a look at the top-level object description for more details on the specific meaning.
      schema:
        type: array
        example:
        - thresholds
        uniqueItems: true
        items:
          type: string
          enum:
          - thresholds
          - parameter_schemas
          - schema_info
          example: thresholds