openapi: 3.0.3
components:
  schemas:
    0rtt:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - 0rtt
            example: 0rtt
          value:
            $ref: '#/components/schemas/0rtt_value'
      title: 0-RTT Value
      description: 0-RTT session resumption enabled for this zone.
    0rtt_value:
      type: string
      description: Value of the 0-RTT setting.
      enum:
      - "on"
      - "off"
      default: "off"
    AAAARecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - properties:
          content:
            type: string
            format: ipv6
            description: A valid IPv6 address.
            example: 2400:cb00:2049:1::173.245.59.16
          name:
            $ref: '#/components/schemas/dns-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - AAAA
            example: AAAA
      title: AAAA Record
      required:
      - type
      - name
      - content
    ARecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - properties:
          content:
            type: string
            format: ipv4
            description: A valid IPv4 address.
            example: 198.51.100.4
          name:
            $ref: '#/components/schemas/dns-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - A
            example: A
      title: A Record
      required:
      - type
      - name
      - content
    CERTRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - 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-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - CERT
            example: CERT
      title: CERT Record
      required:
      - type
      - name
      - data
    CNAMERecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - properties:
          content:
            description: A valid hostname.
          name:
            $ref: '#/components/schemas/dns-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - CNAME
            example: CNAME
      title: CNAME Record
      required:
      - type
      - name
      - content
    Cloudflare Client API_domain-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/domain'
    Cloudflare Client API_domain-response-single:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - type: object
        properties:
          result:
            $ref: '#/components/schemas/domain'
    Cloudflare Client API_domain_name:
      type: string
      description: Domain name.
      example: cloudflare.com
    Cloudflare Client API_identifier:
      type: string
      description: Policy identifier.
      example: f267e341f3dd4697bd3b9f71dd96247f
      readOnly: true
    CustomNS:
      title: Custom NS
      description: A single account custom nameserver.
      required:
      - dns_records
      - ns_name
      - status
      - zone_tag
      properties:
        dns_records:
          type: array
          description: A and AAAA records associated with the nameserver.
          items:
            properties:
              type:
                type: string
                description: DNS record type.
                enum:
                - A
                - AAAA
                example: A
              value:
                type: string
                description: DNS record contents (an IPv4 or IPv6 address).
                example: 1.1.1.1
        ns_name:
          $ref: '#/components/schemas/ns_name'
        status:
          type: string
          description: Verification status of the nameserver.
          enum:
          - moved
          - pending
          - verified
          example: verified
        zone_tag:
          $ref: '#/components/schemas/common_components-schemas-identifier'
    CustomNSInput:
      title: Custom NS Input
      required:
      - ns_name
      properties:
        ns_name:
          $ref: '#/components/schemas/ns_name'
    DNSKEYRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - 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-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - DNSKEY
            example: DNSKEY
      title: DNSKEY Record
      required:
      - type
      - name
      - data
    DSRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - 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-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - DS
            example: DS
      title: DS Record
      required:
      - type
      - name
      - data
    HTTPSRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - 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-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - HTTPS
            example: HTTPS
      title: HTTPS Record
      required:
      - type
      - name
      - data
    Host:
      type: array
      description: The 'Host' header allows to override the hostname set in the HTTP
        request. Current support is 1 'Host' header override per origin.
      items:
        type: string
        example: example.com
    LOCRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - 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: 4.284967295e+07
              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: 9e+07
              precision_vert:
                type: number
                description: Vertical precision of location.
                default: 0
                example: 0
                minimum: 0
                maximum: 9e+07
              size:
                type: number
                description: Size of location in meters.
                default: 0
                example: 100
                minimum: 0
                maximum: 9e+07
          name:
            $ref: '#/components/schemas/dns-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - LOC
            example: LOC
      title: LOC Record
      required:
      - type
      - name
      - data
    MXRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - properties:
          content:
            type: string
            format: hostname
            description: A valid mail server hostname.
            example: mx.example.com
          name:
            $ref: '#/components/schemas/dns-record_components-schemas-name'
          priority:
            $ref: '#/components/schemas/priority'
          type:
            description: Record type.
            enum:
            - MX
            example: MX
      title: MX Record
      required:
      - type
      - name
      - content
      - priority
    NAPTRRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - 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-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - NAPTR
            example: NAPTR
      title: NAPTR Record
      required:
      - type
      - name
      - data
    NSRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - properties:
          content:
            description: A valid name server host name.
            example: ns1.example.com
          name:
            $ref: '#/components/schemas/dns-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - NS
            example: NS
      title: NS Record
      required:
      - type
      - name
      - content
    SMIMEARecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - 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-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - SMIMEA
            example: SMIMEA
      title: SMIMEA Record
      required:
      - type
      - name
      - data
    SRVRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - 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.
                example: example.com
              port:
                type: number
                description: The port of the service.
                example: 8806
                minimum: 0
                maximum: 65535
              priority:
                $ref: '#/components/schemas/priority'
              proto:
                type: string
                description: A valid protocol.
                example: _tcp
              service:
                type: string
                description: A service type, prefixed with an underscore.
                example: _sip
              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: Service, protocol, and SRV name content. See 'data' for setting
              the individual component values.
            example: _sip._tcp.example.com
            readOnly: true
            maxLength: 255
          type:
            description: Record type.
            enum:
            - SRV
            example: SRV
      title: SRV Record
      required:
      - type
      - data
    SSHFPRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - 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-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - SSHFP
            example: SSHFP
      title: SSHFP Record
      required:
      - type
      - name
      - data
    SVCBRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - 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-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - SVCB
            example: SVCB
      title: SVCB Record
      required:
      - type
      - name
      - data
    TLSARecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - 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-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - TLSA
            example: TLSA
      title: TLSA Record
      required:
      - type
      - name
      - data
    TXTRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - properties:
          content:
            type: string
            description: Text content for the record.
            example: example text content
          name:
            $ref: '#/components/schemas/dns-record_components-schemas-name'
          type:
            description: Record type.
            enum:
            - TXT
            example: TXT
      title: TXT Record
      required:
      - type
      - name
      - content
    URIRecord:
      allOf:
      - $ref: '#/components/schemas/dns-record_components-schemas-base'
      - 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-record_components-schemas-name'
          priority:
            $ref: '#/components/schemas/priority'
          type:
            description: Record type.
            enum:
            - URI
            example: URI
      title: URI Record
      required:
      - type
      - name
      - data
      - priority
    access-policy:
      oneOf:
      - $ref: '#/components/schemas/policy_with_permission_groups'
      type: object
    access-requests:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/access-requests_components-schemas-action'
        allowed:
          $ref: '#/components/schemas/schemas-allowed'
        app_domain:
          $ref: '#/components/schemas/app_domain'
        app_uid:
          $ref: '#/components/schemas/app_uid'
        connection:
          $ref: '#/components/schemas/components-schemas-connection'
        created_at:
          $ref: '#/components/schemas/timestamp'
        ip_address:
          $ref: '#/components/schemas/components-schemas-ip'
        ray_id:
          $ref: '#/components/schemas/ray_id'
        user_email:
          $ref: '#/components/schemas/schemas-email'
    access-requests_components-schemas-action:
      type: string
      description: The event that occurred, such as a login attempt.
      example: login
    access-requests_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    access-requests_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/access-requests'
    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
    access_seat:
      type: boolean
      description: True if the seat is part of Access.
      example: false
    accessRules:
      type: object
      description: Defines rules for fine-grained control over content than signed
        URL tokens alone. Access rules primarily make tokens conditionally valid based
        on user information. Access Rules are specified on token payloads as the `accessRules`
        property containing an array of Rule objects.
      readOnly: true
      properties:
        action:
          type: string
          description: The action to take when a request matches a rule. If the action
            is `block`, the signed token blocks views for viewers matching the rule.
          enum:
          - allow
          - block
          example: allow
          readOnly: true
        country:
          type: array
          description: An array of 2-letter country codes in ISO 3166-1 Alpha-2 format
            used to match requests.
          readOnly: true
          items:
            type: string
        ip:
          type: array
          description: An array of IPv4 or IPV6 addresses or CIDRs used to match requests.
          readOnly: true
          items:
            type: string
        type:
          type: string
          description: Lists available rule types to match for requests. An `any`
            type matches all requests and can be used as a wildcard to apply default
            actions after other rules.
          enum:
          - any
          - ip.src
          - ip.geoip.country
          example: ip.src
          readOnly: true
    account:
      type: object
      required:
      - id
      - name
      properties:
        created_on:
          type: string
          format: date-time
          description: Timestamp for the creation of the account
          example: "2014-03-01T12:21:02.0000Z"
          readOnly: true
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        name:
          type: string
          description: Account name
          example: Demo Account
          maxLength: 100
        settings:
          type: object
          description: Account settings
          properties:
            enforce_twofactor:
              type: boolean
              description: |-
                Indicates whether membership in this account requires that
                Two-Factor Authentication is enabled
              default: false
            use_account_custom_ns_by_default:
              type: boolean
              description: |-
                Indicates whether new zones should use the account-level custom
                nameservers by default
              default: false
    account-settings-response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
            properties:
              default_usage_model:
                readOnly: true
              green_compute:
                readOnly: true
    account_identifier: {}
    account_subscription_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/subscription'
    account_subscription_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    accounts_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    acl:
      type: object
      required:
      - id
      - name
      - ip_range
      properties:
        id:
          $ref: '#/components/schemas/acl_components-schemas-identifier'
        ip_range:
          $ref: '#/components/schemas/ip_range'
        name:
          $ref: '#/components/schemas/acl_components-schemas-name'
    acl_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/acl_components-schemas-identifier'
    acl_components-schemas-identifier:
      example: 23ff594956f20c2a721606e94745a8aa
    acl_components-schemas-name:
      type: string
      description: The name of the acl.
      example: my-acl-1
    acl_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/acl'
    acl_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/acl'
    acns_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/CustomNS'
    acns_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            $ref: '#/components/schemas/CustomNS'
    action:
      type: string
      description: The billing item action.
      example: subscription
      readOnly: true
      maxLength: 30
    action_mode:
      type: string
      description: The default action performed by the rules in the WAF package.
      enum:
      - simulate
      - block
      - challenge
      default: challenge
    action_parameters:
      type: object
      description: The parameters configuring the rule action.
      example:
        id: 4814384a9e5d4991b9815dcfc25d2f1f
    action_parameters_rewrite:
      description: The configuration parameters for the rewrite action.
      properties:
        uri:
          type: object
          description: The URI rewrite configuration to rewrite the URI path, the
            query string, or both.
          properties:
            path:
              description: The new URI path sent to the origin.
            query:
              description: The new query string sent to the origin.
    action_parameters_serve_error:
      description: The action parameters for the serve_error action.
      properties:
        content:
          type: string
          description: The new content for the response error.
          example: some html error page
        content_type:
          type: string
          description: The content-type of the response error.
          example: text/html
        status_code:
          type: number
          description: The HTTP status code of the response error.
          example: 530
    actions:
      type: array
      description: List actions patterns.
      items:
        $ref: '#/components/schemas/schemas-action'
    activated_on:
      type: string
      format: date-time
      description: When the Railgun was activated.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    activation:
      type: object
      readOnly: true
      required:
      - key
      properties:
        activated_on:
          $ref: '#/components/schemas/activated_on'
        key:
          $ref: '#/components/schemas/activation_key'
        version:
          type: object
          required:
          - number
          properties:
            build:
              $ref: '#/components/schemas/build'
            number:
              $ref: '#/components/schemas/railgun_components-schemas-version'
            revision:
              $ref: '#/components/schemas/revision'
    activation_key:
      type: string
      example: e4edc00281cb56ebac22c81be9bac8f3
      readOnly: true
      maxLength: 32
    active_device_count:
      type: number
      description: The number of active devices registered to the user.
      example: 2
    activity-log-settings:
      type: object
      description: Activity log settings.
      properties:
        enabled:
          type: boolean
          description: Enable activity logging.
          example: true
    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
    additional_information:
      type: object
      description: Additional information related to the host name.
      properties:
        suspected_malware_family:
          type: string
          description: Suspected DGA malware family.
          example: ""
    address:
      type: string
      description: The IP address (IPv4 or IPv6) of the origin, or the publicly addressable
        hostname. Hostnames entered here should resolve directly to the origin, and
        not be a hostname proxied by Cloudflare.
      example: 0.0.0.0
    address-maps:
      type: object
      properties:
        can_delete:
          $ref: '#/components/schemas/can_delete'
        can_modify_ips:
          $ref: '#/components/schemas/can_modify_ips'
        created_at:
          $ref: '#/components/schemas/timestamp'
        default_sni:
          $ref: '#/components/schemas/default_sni'
        description:
          $ref: '#/components/schemas/address-maps_components-schemas-description'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        modified_at:
          $ref: '#/components/schemas/timestamp'
    address-maps-ip:
      type: object
      properties:
        created_at:
          $ref: '#/components/schemas/created-on'
        ip:
          $ref: '#/components/schemas/schemas-ip'
    address-maps-membership:
      type: object
      properties:
        can_delete:
          $ref: '#/components/schemas/schemas-can_delete'
        created_at:
          $ref: '#/components/schemas/created-on'
        identifier:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        kind:
          $ref: '#/components/schemas/components-schemas-kind'
    address-maps_components-schemas-description:
      type: string
      description: An optional description field which may be used to describe the
        types of IPs or zones on the map.
      example: My Ecommerce zones
      nullable: true
    address-maps_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/address-maps'
    address-maps_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/address-maps'
    address2:
      type: string
      description: Optional address line for unit, floor, suite, etc.
      example: Suite 430
    addresses:
      allOf:
      - $ref: '#/components/schemas/destination_address_properties'
      type: object
    advanced_certificate_pack_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
            properties:
              certificate_authority:
                $ref: '#/components/schemas/certificate_authority'
              cloudflare_branding:
                $ref: '#/components/schemas/cloudflare_branding'
              hosts:
                $ref: '#/components/schemas/schemas-hosts'
              id:
                $ref: '#/components/schemas/certificate-packs_components-schemas-identifier'
              status:
                $ref: '#/components/schemas/certificate-packs_components-schemas-status'
              type:
                $ref: '#/components/schemas/advanced_type'
              validation_method:
                $ref: '#/components/schemas/validation_method'
              validity_days:
                $ref: '#/components/schemas/validity_days'
    advanced_ddos:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - advanced_ddos
            example: advanced_ddos
          value:
            $ref: '#/components/schemas/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.
    advanced_ddos_value:
      type: string
      description: |-
        Value of the zone setting.
        Notes: Defaults to on for Business+ plans
      enum:
      - "on"
      - "off"
      default: "off"
    advanced_type:
      type: string
      description: Type of certificate pack.
      enum:
      - advanced
      example: advanced
    advertised:
      type: boolean
      description: Prefix advertisement status to the Internet. This field is only
        not 'null' if on demand is enabled.
      example: true
      nullable: true
    advertised_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              advertised:
                $ref: '#/components/schemas/schemas-advertised'
              advertised_modified_at:
                $ref: '#/components/schemas/modified_at_nullable'
    alert-types:
      type: object
      properties:
        description:
          $ref: '#/components/schemas/alert-types_components-schemas-description'
        display_name:
          $ref: '#/components/schemas/display_name'
        filter_options:
          $ref: '#/components/schemas/schemas-filter_options'
        type:
          $ref: '#/components/schemas/alert-types_components-schemas-type'
    alert-types_components-schemas-description:
      type: string
      description: Describes the alert type.
      example: High levels of 5xx HTTP errors at your origin
    alert-types_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: object
            example:
              Origin Monitoring:
              - description: High levels of 5xx HTTP errors at your origin.
                display_name: Origin Error Rate Alert
                filter_options:
                - ComparisonOperator: ==
                  Key: zones
                  Optional: false
                - ComparisonOperator: '>='
                  Key: slo
                  Optional: true
                type: http_alert_origin_error
    alert-types_components-schemas-type:
      type: string
      description: Use this value when creating and updating a notification policy.
      example: http_alert_origin_error
    alert_body:
      type: string
      description: Message body included in the notification sent.
      example: SSL certificate has expired
    alert_type:
      type: string
      description: Refers to which event will trigger a Notification dispatch. You
        can use the endpoint to get available alert types which then will give you
        a list of possible values.
      example: universal_ssl_event_type
    algo:
      type: string
      description: TSIG algorithm.
      example: hmac-sha512.
    allow_all_headers:
      type: boolean
      description: Allows all HTTP request headers.
      example: true
    allow_all_methods:
      type: boolean
      description: Allows all HTTP request methods.
    allow_all_origins:
      type: boolean
      description: Allows all origins.
    allow_credentials:
      type: boolean
      description: When set to `true`, includes credentials (cookies, authorization
        headers, or TLS client certificates) with requests.
    allow_insecure:
      type: boolean
      description: Do not validate the certificate when monitor use HTTPS. This parameter
        is currently only valid for HTTP and HTTPS monitors.
      default: false
      example: true
    allow_mode_switch:
      type: boolean
      description: Whether to allow the user to switch WARP between modes.
      example: true
    allow_null_cipher:
      type: boolean
      description: When `true`, the tunnel can use a null-cipher (`ENCR_NULL`) in
        the ESP tunnel (Phase 2).
      example: true
    allow_updates:
      type: boolean
      description: Whether to receive update notifications when a new version of the
        client is available.
      example: true
    allowed:
      type: number
      description: Cloudflare Images allowed usage.
      example: 100000
      readOnly: true
    allowed_headers:
      type: array
      description: Allowed HTTP request headers.
      items: {}
    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
    allowed_methods:
      type: array
      description: Allowed HTTP request methods.
      example:
      - GET
      items:
        type: string
        enum:
        - GET
        - POST
        - HEAD
        - PUT
        - DELETE
        - CONNECT
        - OPTIONS
        - TRACE
        - PATCH
    allowed_modes:
      type: array
      description: The available states for the rule group.
      example:
      - "on"
      - "off"
      readOnly: true
      items:
        $ref: '#/components/schemas/components-schemas-mode'
    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/mode_allow_traditional'
    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/mode_anomaly'
    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/mode_deny_traditional'
    allowed_origins:
      type: array
      description: Allowed origins.
      example:
      - https://example.com
      items: {}
    allowed_to_leave:
      type: boolean
      description: Whether to allow devices to leave the organization.
      example: true
    allowedOrigins:
      type: array
      description: Lists the origins allowed to display the video. Enter allowed origin
        domains in an array and use `*` for wildcard subdomains. Empty arrays allow
        the video to be viewed on any origin.
      example:
      - example.com
      items:
        type: string
    always_online:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - always_online
            example: always_online
          value:
            $ref: '#/components/schemas/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.
    always_online_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "on"
    always_use_https:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - always_use_https
            example: always_use_https
          value:
            $ref: '#/components/schemas/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"
    always_use_https_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    amount:
      type: number
      description: The amount associated with this billing item.
      example: 20.99
      readOnly: true
    analytics:
      type: object
      properties:
        id:
          type: integer
          default: 1
        origins:
          type: array
          example:
          - address: 198.51.100.4
            changed: true
            enabled: true
            failure_reason: No failures
            healthy: true
            ip: 198.51.100.4
            name: some-origin
          items: {}
        pool:
          type: object
          example:
            changed: true
            healthy: true
            id: 74bc6a8b9b0dda3d651707a2928bad0c
            minimum_origins: 1
            name: some-pool
        timestamp:
          type: string
          format: date-time
          example: "2014-01-01T05:20:00.12345Z"
    analytics-aggregate_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: array
            items:
              type: object
    analytics_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/analytics'
    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
    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
    anomaly_name:
      type: string
      description: The name of the WAF package.
      example: OWASP ModSecurity Core Rule Set
      readOnly: true
    anomaly_package:
      allOf:
      - $ref: '#/components/schemas/package_definition'
      - properties:
          action_mode:
            $ref: '#/components/schemas/action_mode'
          description:
            $ref: '#/components/schemas/anomaly_description'
          detection_mode:
            $ref: '#/components/schemas/anomaly_detection_mode'
          name:
            $ref: '#/components/schemas/anomaly_name'
          sensitivity:
            $ref: '#/components/schemas/sensitivity'
      title: Anomaly detection WAF package (OWASP)
      required:
      - id
      - name
      - description
      - zone_id
      - detection_mode
      - sensitivity
      - action_mode
    anomaly_rule:
      allOf:
      - $ref: '#/components/schemas/rule_components-schemas-base-2'
      - properties:
          allowed_modes:
            $ref: '#/components/schemas/allowed_modes_anomaly'
          mode:
            $ref: '#/components/schemas/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
    anti-virus-settings:
      type: object
      description: Anti virus settings.
      properties:
        enabled_download_phase:
          $ref: '#/components/schemas/enabled_download_phase'
        enabled_upload_phase:
          $ref: '#/components/schemas/enabled_upload_phase'
        fail_closed:
          $ref: '#/components/schemas/fail_closed'
    api-response-collection:
      anyOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: array
            nullable: true
            items: {}
          result_info:
            $ref: '#/components/schemas/result_info'
      type: object
    api-response-common:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          $ref: '#/components/schemas/messages'
        messages:
          $ref: '#/components/schemas/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-response-common-failure:
      type: object
      required:
      - success
      - errors
      - messages
      - result
      properties:
        errors:
          allOf:
          - $ref: '#/components/schemas/messages'
          example:
          - code: 7003
            message: No route for the URI
          minLength: 1
        messages:
          allOf:
          - $ref: '#/components/schemas/messages'
          example: []
        result:
          enum:
          - null
          nullable: true
        success:
          type: boolean
          description: Whether the API call was successful
          enum:
          - false
          example: false
    api-response-single:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            anyOf:
            - type: object
            - type: string
            nullable: true
      type: object
    api-response-single-id:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            required:
            - id
            properties:
              id:
                $ref: '#/components/schemas/common_components-schemas-identifier'
      type: object
    api-shield:
      allOf:
      - $ref: '#/components/schemas/operation'
    api_access_enabled:
      type: boolean
      description: Enterprise only. Indicates whether or not API access is enabled
        specifically for this user on a given account.
      example: true
      nullable: true
    app-types:
      oneOf:
      - $ref: '#/components/schemas/application'
      - $ref: '#/components/schemas/application_type'
      type: object
      readOnly: true
    app-types_components-schemas-name:
      type: string
      description: The name of the application or application type.
      example: Facebook
    app-types_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/app-types'
    app_components-schemas-created:
      type: string
      format: date-time
      description: When the Application was created.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    app_components-schemas-modified:
      type: string
      format: date-time
      description: When the Application was last modified.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    app_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              type: object
    app_domain:
      type: string
      description: The URL of the Access application.
      example: test.example.com/admin
    app_id:
      type: string
      description: Application identifier.
      example: ea95132c15732412d22c1476fa83f27a
      readOnly: true
      maxLength: 32
    app_launcher_props:
      allOf:
      - $ref: '#/components/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
    app_launcher_visible:
      type: boolean
      description: Displays the application in the App Launcher.
      default: true
      example: true
    app_type_id:
      type: integer
      description: The identifier for the type of this application. There can be many
        applications with the same type. This refers to the `id` of an Application
        Type that has been returned.
    app_uid:
      description: The unique identifier for the Access application.
      example: df7e2w5f-02b7-4d9d-af26-8d1988fca630
    application:
      type: object
      properties:
        application_type_id:
          $ref: '#/components/schemas/app_type_id'
        created_at:
          $ref: '#/components/schemas/timestamp'
        id:
          $ref: '#/components/schemas/components-schemas-app_id'
        name:
          $ref: '#/components/schemas/app-types_components-schemas-name'
    application_type:
      type: object
      properties:
        created_at:
          $ref: '#/components/schemas/timestamp'
        description:
          type: string
          description: A short summary of applications with this type.
          example: Applications used to communicate or collaborate in a business setting.
        id:
          $ref: '#/components/schemas/app_type_id'
        name:
          $ref: '#/components/schemas/app-types_components-schemas-name'
    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.
    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/approval_group'
    approval_required:
      type: boolean
      description: Requires the user to request access from an administrator at the
        start of each session.
      default: false
      example: true
    approved:
      type: string
      description: Approval state of the prefix (P = pending, V = active).
      example: P
    apps:
      anyOf:
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/self_hosted_props'
        type: object
        title: Self Hosted Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/saas_props'
        type: object
        title: SaaS Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/ssh_props'
        type: object
        title: Browser SSH Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/vnc_props'
        type: object
        title: Browser VNC Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/app_launcher_props'
        type: object
        title: App Launcher Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/warp_props'
        type: object
        title: Device Enrollment Permissions Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/biso_props'
        type: object
        title: Browser Isolation Permissions Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/bookmark_props'
        type: object
        title: Bookmark application
    apps_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/uuid'
    apps_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    apps_components-schemas-name:
      type: string
      description: The name of the application.
      example: Admin Site
    apps_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/apps'
    apps_components-schemas-response_collection-2:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/schemas-apps'
    apps_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/apps'
    apps_components-schemas-single_response-2:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/schemas-apps'
    apps_components-schemas-type:
      type: string
      description: The application type.
      enum:
      - self_hosted
      - saas
      - ssh
      - vnc
      - app_launcher
      - warp
      - biso
      - bookmark
      - dash_sso
      example: self_hosted
    arch:
      type: string
      description: The cloudflared OS architecture used to establish this connection.
      example: linux_amd64
    argo-tunnel:
      type: object
      required:
      - id
      - name
      - created_at
      - connections
      properties:
        connections:
          type: array
          description: The tunnel connections between your origin and Cloudflare's
            edge.
          items:
            $ref: '#/components/schemas/argo-tunnel_components-schemas-connection'
        created_at:
          $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-created_at'
        deleted_at:
          $ref: '#/components/schemas/schemas-deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_id'
        name:
          $ref: '#/components/schemas/tunnel_name'
    argo-tunnel_components-schemas-connection:
      properties:
        colo_name:
          $ref: '#/components/schemas/schemas-colo_name'
        is_pending_reconnect:
          $ref: '#/components/schemas/is_pending_reconnect'
        uuid:
          $ref: '#/components/schemas/connection_id'
    argo-tunnel_components-schemas-empty_response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - type: object
        properties:
          result:
            type: object
    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
    asn:
      type: integer
      description: Autonomous System Number (ASN) the prefix will be advertised under.
      nullable: true
    asn_components-schemas-asn:
      properties:
        asn:
          $ref: '#/components/schemas/components-schemas-asn'
        country:
          $ref: '#/components/schemas/asn_country'
        description:
          $ref: '#/components/schemas/asn_description'
        domain_count:
          type: integer
        top_domains:
          type: array
          example:
          - example.com
          items:
            type: string
        type:
          $ref: '#/components/schemas/asn_type'
    asn_components-schemas-response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/asn_components-schemas-asn'
    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
    asn_country:
      type: string
      example: US
    asn_description:
      type: string
      example: CLOUDFLARENET
    asn_type:
      type: string
      description: Infrastructure type of this ASN.
      enum:
      - hosting_provider
      - isp
      - organization
      example: hosting_provider
    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
    attack_mitigation:
      type: object
      description: Attack mitigation settings.
      nullable: true
      properties:
        enabled:
          type: boolean
          description: When enabled, random-prefix attacks are automatically mitigated
            and the origin DNS servers protected.
          example: true
        only_when_origin_unhealthy:
          type: boolean
          description: Only mitigate attacks when origin servers seem unhealthy.
          default: true
          example: false
    aud:
      type: string
      description: The Application Audience (AUD) tag. Identifies the application
        associated with the CA.
      example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893
      readOnly: true
      maxLength: 64
    audit-logs:
      type: object
      properties:
        action:
          type: object
          properties:
            result:
              type: boolean
              description: A boolean that indicates if the action attempted was successful.
              example: true
            type:
              type: string
              description: A short string that describes the action that was performed.
              example: change_setting
        actor:
          type: object
          properties:
            email:
              type: string
              format: email
              description: The email of the user that performed the action.
              example: michelle@example.com
            id:
              type: string
              description: The ID of the actor that performed the action. If a user
                performed the action, this will be their User ID.
              example: f6b5de0326bb5182b8a4840ee01ec774
            ip:
              type: string
              description: The IP address of the request that performed the action.
              example: 198.41.129.166
            type:
              type: string
              description: The type of actor, whether a User, Cloudflare Admin, or
                an Automated System.
              enum:
              - user
              - admin
              - Cloudflare
              example: user
        id:
          type: string
          description: A string that uniquely identifies the audit log.
          example: d5b0f326-1232-4452-8858-1089bd7168ef
        interface:
          type: string
          description: The source of the event.
          example: API
        metadata:
          type: object
          description: An object which can lend more context to the action being logged.
            This is a flexible value and varies between different actions.
          example:
            name: security_level
            type: firewall
            value: high
            zone_name: example.com
        newValue:
          type: string
          description: The new value of the resource that was modified.
          example: low
        oldValue:
          type: string
          description: The value of the resource before it was modified.
          example: high
        owner:
          type: object
          properties:
            id:
              $ref: '#/components/schemas/common_components-schemas-identifier'
        resource:
          type: object
          properties:
            id:
              type: string
              description: An identifier for the resource that was affected by the
                action.
              example: 023e105f4ecef8ad9ca31a8372d0c353
            type:
              type: string
              description: A short string that describes the resource that was affected
                by the action.
              example: zone
        when:
          type: string
          format: date-time
          description: A UTC RFC3339 timestamp that specifies when the action being
            logged occured.
          example: "2017-04-26T17:31:07Z"
    audit_logs_response_collection:
      oneOf:
      - properties:
          errors:
            nullable: true
          messages:
            type: array
            example: []
            items: {}
          result:
            type: array
            items:
              $ref: '#/components/schemas/audit-logs'
          success:
            type: boolean
            example: true
      - $ref: '#/components/schemas/api-response-common'
    auth_domain:
      type: string
      description: The unique subdomain assigned to your Zero Trust organization.
      example: test.cloudflareaccess.com
    auth_id_tokens:
      type: integer
      description: The total number of auth-ids seen across this calculation.
      readOnly: true
    auto_connect:
      type: number
      description: The amount of time in minutes to reconnect after having been disabled.
      example: 0
    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
    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
    auto_renew:
      type: boolean
      description: Auto-renew controls whether subscription is automatically renewed
        upon domain expiration.
      example: true
    automatic_https_rewrites:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - automatic_https_rewrites
            example: automatic_https_rewrites
          value:
            $ref: '#/components/schemas/automatic_https_rewrites_value'
      title: Zone Enable Automatic HTTPS Rewrites
      description: Enable the Automatic HTTPS Rewrites feature for this zone.
      default: "off"
    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"
    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
    availability_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              type: string
              format: hostname
              description: Name of zone based on which account custom nameservers
                can be created. For example, if example.com is returned, then ns1.example.com
                can be used as an account custom nameserver.
              example: example.com
              readOnly: true
    available:
      type: boolean
      description: When true, the Managed Transform is available in the current Cloudflare
        plan.
      example: true
    available-rate-plan:
      type: object
      properties:
        can_subscribe:
          $ref: '#/components/schemas/can_subscribe'
        currency:
          $ref: '#/components/schemas/currency'
        externally_managed:
          $ref: '#/components/schemas/externally_managed'
        frequency:
          $ref: '#/components/schemas/schemas-frequency'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        is_subscribed:
          $ref: '#/components/schemas/is_subscribed'
        legacy_discount:
          $ref: '#/components/schemas/legacy_discount'
        legacy_id:
          $ref: '#/components/schemas/legacy_id'
        name:
          $ref: '#/components/schemas/rate-plan_components-schemas-name'
        price:
          $ref: '#/components/schemas/schemas-price'
    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
    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: 1.234242e+06
            html: 1.23129e+06
            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: 2.342483e+06
            GI: 984753
            US: 1.23145433e+08
        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.
    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.
    base:
      type: object
      required:
      - invited_member_id
      - organization_id
      properties:
        expires_on:
          $ref: '#/components/schemas/schemas-expires_on'
        id:
          $ref: '#/components/schemas/invite_components-schemas-identifier'
        invited_by:
          $ref: '#/components/schemas/invited_by'
        invited_member_email:
          $ref: '#/components/schemas/invited_member_email'
        invited_member_id:
          type: string
          description: ID of the user to add to the organization.
          example: 5a7805061c76ada191ed06f989cc3dac
          nullable: true
          readOnly: true
          maxLength: 32
        invited_on:
          $ref: '#/components/schemas/invited_on'
        organization_id:
          type: string
          description: ID of the organization the user will be added to.
          example: 5a7805061c76ada191ed06f989cc3dac
          readOnly: true
          maxLength: 32
        organization_name:
          type: string
          description: Organization name.
          example: Cloudflare, Inc.
          readOnly: true
          maxLength: 100
        roles:
          type: array
          description: Roles to be assigned to this user.
          items:
            $ref: '#/components/schemas/schemas-role'
    basic_app_response_props:
      type: object
      properties:
        aud:
          $ref: '#/components/schemas/schemas-aud'
        created_at:
          $ref: '#/components/schemas/timestamp'
        id:
          $ref: '#/components/schemas/uuid'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    batch_size:
      type: number
      example: 10
    beta:
      type: boolean
      description: Whether the category is in beta and subject to change.
      example: false
    billing-history:
      type: object
      required:
      - id
      - type
      - action
      - description
      - occurred_at
      - amount
      - currency
      - zone
      properties:
        action:
          $ref: '#/components/schemas/action'
        amount:
          $ref: '#/components/schemas/amount'
        currency:
          $ref: '#/components/schemas/currency'
        description:
          $ref: '#/components/schemas/schemas-description'
        id:
          $ref: '#/components/schemas/billing-history_components-schemas-identifier'
        occurred_at:
          $ref: '#/components/schemas/occurred_at'
        type:
          $ref: '#/components/schemas/type'
        zone:
          $ref: '#/components/schemas/schemas-zone'
    billing-history_components-schemas-identifier:
      type: string
      description: Billing item identifier tag.
      example: b69a9f3492637782896352daae219e7d
      readOnly: true
      maxLength: 32
    billing_history_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/billing-history'
    billing_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    binding:
      oneOf:
      - $ref: '#/components/schemas/kv_namespace_binding'
      - $ref: '#/components/schemas/wasm_module_binding'
    binding_name:
      type: string
      description: A JavaScript variable name for the binding.
      example: myBinding
      readOnly: true
    biso_props:
      allOf:
      - $ref: '#/components/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
    block-page-settings:
      type: object
      description: Block page layout settings.
      properties:
        background_color:
          type: string
          description: 'Block page background color in #rrggbb format.'
        enabled:
          type: boolean
          description: Enable only cipher suites and TLS versions compliant with FIPS
            140-2.
          example: true
        footer_text:
          type: string
          description: Block page footer text.
          example: --footer--
        header_text:
          type: string
          description: Block page header text.
          example: --header--
        logo_path:
          type: string
          description: Full URL to the logo file.
          example: https://logos.com/a.png
        mailto_address:
          type: string
          description: Admin email for users to contact.
          example: admin@example.com
        mailto_subject:
          type: string
          description: Subject line for emails created from block page.
          example: Blocked User Inquiry
        name:
          type: string
          description: Block page title.
          example: Cloudflare
        suppress_footer:
          type: boolean
          description: Suppress detailed info at the bottom of the block page.
          example: false
    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
    bookmark_props:
      type: object
      title: Bookmark application
      properties:
        app_launcher_visible:
          default: true
        domain:
          description: The URL or domain of the bookmark.
          example: https://mybookmark.com
        logo_url:
          $ref: '#/components/schemas/logo_url'
        name:
          $ref: '#/components/schemas/apps_components-schemas-name'
        type:
          type: string
          description: The application type.
          example: bookmark
    bookmarks:
      type: object
      properties:
        app_launcher_visible:
          $ref: '#/components/schemas/schemas-app_launcher_visible'
        created_at:
          $ref: '#/components/schemas/timestamp'
        domain:
          $ref: '#/components/schemas/components-schemas-domain'
        id:
          description: The unique identifier for the Bookmark application.
        logo_url:
          $ref: '#/components/schemas/logo_url'
        name:
          $ref: '#/components/schemas/bookmarks_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    bookmarks_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/uuid'
    bookmarks_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    bookmarks_components-schemas-name:
      type: string
      description: The name of the Bookmark application.
      example: My Website
    bookmarks_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/bookmarks'
    bookmarks_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/bookmarks'
    brand_check:
      type: boolean
      description: Certificate Authority is manually reviewing the order.
      example: false
    brotli:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - brotli
            example: brotli
          value:
            $ref: '#/components/schemas/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.
    brotli_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "off"
      - "on"
      default: "off"
    browser-isolation-settings:
      type: object
      description: Browser isolation settings.
      properties:
        url_browser_isolation_enabled:
          type: boolean
          description: Enable Browser Isolation.
          example: true
    browser_cache_ttl:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - browser_cache_ttl
            example: browser_cache_ttl
          value:
            $ref: '#/components/schemas/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).
    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
      - 1.3824e+06
      - 2.0736e+06
      - 2.6784e+06
      - 5.3568e+06
      - 1.60704e+07
      - 3.1536e+07
      default: 14400
    browser_check:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - browser_check
            example: browser_check
          value:
            $ref: '#/components/schemas/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).
    browser_check_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "on"
    bucket_name:
      type: string
      description: Name of the bucket. The name must be greater than 2 and less than
        64 characters.
      example: example-bucket
      pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]
    build:
      type: string
      description: The build identifier for the Railgun receiver.
      example: b1234
      readOnly: true
    build_config:
      type: object
      description: Configs for the project build process.
      properties:
        build_command:
          type: string
          description: Command used to build project.
          example: npm run build
          nullable: true
        destination_dir:
          type: string
          description: Output directory of the build.
          example: build
          nullable: true
        root_dir:
          type: string
          description: Directory to run the command.
          example: /
          nullable: true
        web_analytics_tag:
          type: string
          description: The classifying tag for analytics.
          example: cee1c73f6e4743d0b5e6bb1a0bcaabcc
          nullable: true
        web_analytics_token:
          type: string
          description: The auth token for analytics.
          example: 021e1057c18547eca7b79f2516f06o7x
          nullable: true
    bulk-operation-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            $ref: '#/components/schemas/schemas-operation'
    bulk_delete:
      type: array
      items:
        $ref: '#/components/schemas/key_name_bulk'
    bulk_write:
      type: array
      items:
        type: object
        properties:
          base64:
            type: boolean
            description: Whether or not the server should base64 decode the value
              before storing it. Useful for writing values that wouldn't otherwise
              be valid JSON strings, such as images.
            default: false
          expiration:
            $ref: '#/components/schemas/expiration'
          expiration_ttl:
            $ref: '#/components/schemas/expiration_ttl'
          key:
            $ref: '#/components/schemas/key_name_bulk'
          metadata:
            $ref: '#/components/schemas/list_metadata'
          value:
            type: string
            description: A UTF-8 encoded string to be stored, up to 10 MB in length.
            example: Some string
            maxLength: 10485760
      required:
      - key
      - value
    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
    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/*
    ca:
      type: object
      properties:
        aud:
          $ref: '#/components/schemas/aud'
        id:
          $ref: '#/components/schemas/ca_components-schemas-id'
        public_key:
          $ref: '#/components/schemas/public_key'
    ca_components-schemas-id:
      type: string
      description: The ID of the CA.
      example: 7eddae4619b50ab1361ba8ae9bd72269a432fea041529ed9
      readOnly: true
      maxLength: 48
    ca_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/ca_components-schemas-id'
    ca_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/ca'
    ca_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    cache_level:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - cache_level
            example: cache_level
          value:
            $ref: '#/components/schemas/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).
    cache_level_value:
      type: string
      description: Value of the zone setting.
      enum:
      - aggressive
      - basic
      - simplified
      default: aggressive
    cache_reserve:
      allOf:
      - $ref: '#/components/schemas/components-schemas-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.'
    cache_reserve_response_value:
      properties:
        result:
          allOf:
          - $ref: '#/components/schemas/cache_reserve'
          - required:
            - value
            properties:
              value:
                $ref: '#/components/schemas/cache_reserve_value'
    cache_reserve_value:
      type: string
      description: Value of the Cache Reserve zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    can_delete:
      type: boolean
      description: If set to false, then the Address Map cannot be deleted via API.
        This is true for Cloudflare-managed maps.
      example: true
      readOnly: true
    can_modify_ips:
      type: boolean
      description: If set to false, then the IPs on the Address Map cannot be modified
        via the API. This is true for Cloudflare-managed maps.
      example: true
      readOnly: true
    can_register:
      type: boolean
      description: Indicates if the domain can be registered as a new domain.
      example: false
    can_subscribe:
      type: boolean
      description: Indicates whether you can subscribe to this plan.
      default: false
      example: true
    caption_basic_upload:
      type: object
      required:
      - file
      properties:
        file:
          type: string
          description: The WebVTT file containing the caption or subtitle content.
          example: '@/Users/kyle/Desktop/tr.vtt'
    captions:
      type: object
      properties:
        label:
          $ref: '#/components/schemas/label'
        language:
          $ref: '#/components/schemas/language'
    captive_portal:
      type: number
      description: Turn on the captive portal after the specified amount of time.
      example: 180
    catch_all_rule_response_single:
      type: object
      properties:
        actions:
          $ref: '#/components/schemas/catchall-actions'
        enabled:
          $ref: '#/components/schemas/rules_components-schemas-enabled'
        matchers:
          $ref: '#/components/schemas/catchall-matchers'
        name:
          $ref: '#/components/schemas/rules_components-schemas-name'
        tag:
          $ref: '#/components/schemas/rule_identifier'
    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
    catchall-actions:
      type: array
      description: List actions for the catch-all routing rule.
      items:
        $ref: '#/components/schemas/catchall-action'
    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
    catchall-matchers:
      type: array
      description: List of matchers for the catch-all routing rule.
      items:
        $ref: '#/components/schemas/catchall-matcher'
    categories:
      type: array
      description: The categories of the rule.
      example:
      - directory-traversal
      - header
      items:
        $ref: '#/components/schemas/category'
    categories_components-schemas-description:
      type: string
      description: A short summary of domains in the category.
      example: Sites related to educational content that are not included in other
        categories like Science, Technology or Educational institutions.
    categories_components-schemas-id:
      type: integer
      description: The identifier for this category. There is only one category per
        id.
    categories_components-schemas-name:
      type: string
      description: The name of the category.
      example: Education
    categories_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/schemas-categories'
    category:
      type: string
      description: A category of the rule.
      example: directory-traversal
    cert_pack_uuid:
      type: string
      description: Certificate Pack UUID.
      example: a77f8bd7-3b47-46b4-a6f1-75cf98109948
    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-----
    certificate-packs_components-schemas-identifier:
      type: string
      description: The unique identifier for a certificate_pack.
      example: 3822ff90-ea29-44df-9e55-21300bb9419b
      readOnly: true
    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
    certificate_analyze_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    certificate_authority:
      type: string
      description: 'Certificate Authority selected for the order.  Selecting Let''s
        Encrypt will reduce customization of other fields: validation_method must
        be ''txt'', validity_days must be 90, cloudflare_branding must be omitted,
        and hosts must contain only 2 entries, one for the zone name and one for the
        subdomain wildcard of the zone name (e.g. example.com, *.example.com).'
      enum:
      - digicert
      - google
      - lets_encrypt
      example: digicert
    certificate_pack_quota_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
            properties:
              advanced:
                $ref: '#/components/schemas/quota'
    certificate_pack_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              type: object
    certificate_pack_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    certificate_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/custom-certificate'
    certificate_response_id_only:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/custom-certificate_components-schemas-identifier'
    certificate_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    certificate_response_single_id:
      allOf:
      - $ref: '#/components/schemas/schemas-certificate_response_single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/certificates_components-schemas-identifier'
    certificate_rule:
      type: object
      title: Valid certificate
      description: Matches any valid client certificate.
      example:
        certificate: {}
      required:
      - certificate
      properties:
        certificate:
          type: object
          example: {}
    certificate_status:
      type: string
      description: Current status of certificate.
      enum:
      - initializing
      - authorizing
      - active
      - expired
      - issuing
      - timing_out
      - pending_deployment
      example: active
    certificateObject:
      properties:
        certificate:
          $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate'
        expires_on:
          $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-expires_on'
        id:
          $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier'
        issuer:
          $ref: '#/components/schemas/issuer'
        signature:
          $ref: '#/components/schemas/signature'
        status:
          $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-status'
        uploaded_on:
          $ref: '#/components/schemas/schemas-uploaded_on'
    certificates:
      type: object
      required:
      - hostnames
      - csr
      - requested_validity
      - request_type
      properties:
        certificate:
          $ref: '#/components/schemas/components-schemas-certificate'
        csr:
          $ref: '#/components/schemas/csr'
        expires_on:
          $ref: '#/components/schemas/certificates_components-schemas-expires_on'
        hostnames:
          $ref: '#/components/schemas/hostnames'
        id:
          $ref: '#/components/schemas/certificates_components-schemas-identifier'
        request_type:
          $ref: '#/components/schemas/request_type'
        requested_validity:
          $ref: '#/components/schemas/requested_validity'
    certificates_components-schemas-expires_on:
      type: string
      format: date-time
      description: When the certificate will expire.
      example: "2014-01-01T05:20:00.12345Z"
      readOnly: true
    certificates_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/uuid'
    certificates_components-schemas-identifier:
      type: string
      description: The x509 serial number of the Origin CA certificate.
      example: "328578533902268680212849205732770752308931942346"
      readOnly: true
    certificates_components-schemas-name:
      type: string
      description: The name of the certificate.
      example: Allow devs
    certificates_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/schemas-certificates'
    certificates_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/schemas-certificates'
    cf_account_id:
      type: string
      description: Cloudflare account ID
      example: 699d98642c564d2e855e9661899b7252
      maxLength: 32
    challenge_ttl:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - challenge_ttl
            example: challenge_ttl
          value:
            $ref: '#/components/schemas/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).
    challenge_ttl_value:
      type: number
      description: Value of the zone setting.
      enum:
      - 300
      - 900
      - 1800
      - 2700
      - 3600
      - 7200
      - 10800
      - 14400
      - 28800
      - 57600
      - 86400
      - 604800
      - 2.592e+06
      - 3.1536e+07
      default: 1800
    characteristics:
      type: array
      uniqueItems: true
      maxItems: 10
      items:
        type: object
        required:
        - type
        - name
        properties:
          name:
            $ref: '#/components/schemas/characteristics_components-schemas-name'
          type:
            $ref: '#/components/schemas/schemas-type'
    characteristics_components-schemas-name:
      type: string
      description: The name of the characteristic field, i.e., the header or cookie
        name.
      example: authorization
      maxLength: 128
    check_regions:
      type: array
      description: A list of regions from which to run health checks. Null means every
        Cloudflare data center.
      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, SAS: Southern Asia, SEAS: South East Asia, NEAS: North
          East Asia, ALL_REGIONS: all regions (ENTERPRISE customers only).'
        enum:
        - WNAM
        - ENAM
        - WEU
        - EEU
        - NSAM
        - SSAM
        - OC
        - ME
        - NAF
        - SAF
        - SAS
        - SEAS
        - NEAS
        - ALL_REGIONS
    cidr:
      type: string
      description: IP Prefix in Classless Inter-Domain Routing format.
      example: 192.0.2.0/24
    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
    cidr_list:
      type: array
      description: List of IPv4/IPv6 CIDR addresses.
      example:
      - 199.27.128.0/21
      - 2400:cb00::/32
      items:
        type: string
        description: IPv4/IPv6 CIDR.
        example: 199.27.128.0/21
    ciphers:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - ciphers
            example: ciphers
          value:
            $ref: '#/components/schemas/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: []
    ciphers_value:
      type: array
      description: Value of the zone setting.
      default: []
      example:
      - ECDHE-RSA-AES128-GCM-SHA256
      - AES128-SHA
      uniqueItems: true
      items:
        type: string
    city:
      type: string
      description: City.
      example: Austin
    class:
      type: string
      description: Which account types are allowed to create policies based on this
        categories. `blocked` categories are blocked unconditionally for all accounts.
        `removalPending` categories can be removed from policies but not added. `noBlock`
        categories cannot be blocked.
      enum:
      - free
      - premium
      - blocked
      - removalPending
      - noBlock
      example: premium
    client-default:
      type: boolean
      description: Set if the location is the default one.
      example: false
    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
    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
    clipResponseSingle:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            $ref: '#/components/schemas/schemas-output'
    clipped_from_video_uid:
      type: string
      description: The unique video identifier (UID).
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    clipping_components-schemas-created:
      type: string
      format: date-time
      description: The date and time the live input was created.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    cloudflare-tunnel_components-schemas-connection:
      properties:
        client_id:
          description: UUID of the cloudflared instance.
        client_version:
          $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-version'
        colo_name:
          $ref: '#/components/schemas/schemas-colo_name'
        id:
          $ref: '#/components/schemas/connection_id'
        is_pending_reconnect:
          $ref: '#/components/schemas/is_pending_reconnect'
        opened_at:
          type: string
          format: date-time
          description: Timestamp of when the connection was established.
          example: "2021-01-25T18:22:34.317854Z"
        origin_ip:
          type: string
          description: The public IP address of the host running cloudflared.
          example: 85.12.78.6
        uuid:
          $ref: '#/components/schemas/connection_id'
    cloudflare-tunnel_components-schemas-created_at:
      type: string
      format: date-time
      description: Timestamp of when the tunnel was created.
      example: "2021-01-25T18:22:34.317854Z"
    cloudflare-tunnel_components-schemas-empty_response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - type: object
        properties:
          result:
            type: object
    cloudflare-tunnel_components-schemas-metadata:
      type: object
      description: Metadata associated with the tunnel.
      example: {}
    cloudflare-tunnel_components-schemas-status:
      type: string
      description: The status of the tunnel. Valid values are `active`, `inactive`
        or `degraded` (active but not all cloudflared instances have 4 connections
        to Cloudflare's edge).
      example: active
    cloudflare-tunnel_components-schemas-version:
      type: string
      description: The cloudflared version used to establish this connection.
      example: 2022.7.1
    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
    cloudflare_gre_endpoint:
      type: string
      description: The IP address assigned to the Cloudflare side of the GRE tunnel.
      example: 203.0.113.1
    cloudflare_ipsec_endpoint:
      type: string
      description: The IP address assigned to the Cloudflare side of the IPsec tunnel.
      example: 203.0.113.1
    cname_flattening:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: How to flatten the cname destination.
            enum:
            - cname_flattening
            example: flatten_at_root
          value:
            $ref: '#/components/schemas/cname_flattening_value'
      title: Cloudflare CNAME Flattening
      description: Whether or not cname flattening is on.
    cname_flattening_value:
      type: string
      description: Value of the cname flattening setting.
      enum:
      - flatten_at_root
      - flatten_all
      default: flatten_at_root
    code:
      type: string
      description: The unique activation code for the account membership.
      example: 05dd05cce12bbed97c0d87cd78e89bc2fd41a6cee72f27f6fc84af2e45c0fac0
      readOnly: true
      maxLength: 64
    collection_invite_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/invite'
    collection_member_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/components-schemas-member'
    collection_membership_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/membership'
    collection_organization_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/organization'
    collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          errors:
            type: array
            items: {}
          messages:
            type: array
            items: {}
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/api-shield'
              - properties:
                  features: {}
    collection_response_paginated:
      anyOf:
      - allOf:
        - $ref: '#/components/schemas/collection_response'
        - properties:
            result_info:
              type: object
              properties:
                count:
                  type: number
                  description: Total results returned based on your search parameters.
                  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: 500
        - properties:
            result:
              type: array
              items:
                $ref: '#/components/schemas/api-shield'
      - $ref: '#/components/schemas/collection_response'
    collection_role_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/schemas-role'
    colo:
      type: object
      properties:
        city:
          $ref: '#/components/schemas/colo_city'
        name:
          $ref: '#/components/schemas/colo_name'
    colo_city:
      type: string
      description: Source colo city.
      example: Denver, CO, US
    colo_name:
      type: string
      description: Source colo name.
      example: den01
    colo_names:
      type: array
      description: List of colo names for the ECMP scope.
      items:
        $ref: '#/components/schemas/components-schemas-colo_name'
    colo_region:
      type: string
      description: Scope colo region.
      example: APAC
    colo_regions:
      type: array
      description: List of colo regions for the ECMP scope.
      items:
        $ref: '#/components/schemas/colo_region'
    colo_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          query:
            $ref: '#/components/schemas/query_response'
          result:
            $ref: '#/components/schemas/datacenters'
    colo_result:
      type: object
      properties:
        colo:
          $ref: '#/components/schemas/colo'
        error:
          $ref: '#/components/schemas/error'
        hops:
          type: array
          items:
            $ref: '#/components/schemas/hop_result'
        target_summary:
          $ref: '#/components/schemas/target_summary'
        traceroute_time_ms:
          $ref: '#/components/schemas/traceroute_time_ms'
    colos:
      type: array
      description: If no source colo names specified, all colos will be used. China
        colos are unavailable for traceroutes.
      example:
      - den
      - sin
      items:
        type: string
        description: Source colo name.
    comment:
      type: string
      description: Optional remark describing the route.
      example: Example comment for this route.
    common_components-schemas-created_on:
      type: string
      format: date-time
      description: The date and time the tunnel was created.
      example: "2017-06-14T00:00:00Z"
      readOnly: true
    common_components-schemas-identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    common_components-schemas-identifier-2:
      type: string
      description: Tunnel identifier tag.
      example: c4a7362d577a6c3019a474fd6f485821
      readOnly: true
      maxLength: 32
    common_components-schemas-ip:
      anyOf:
      - $ref: '#/components/schemas/ipv4'
      - $ref: '#/components/schemas/schemas-ipv6'
    common_components-schemas-modified_on:
      type: string
      format: date-time
      description: The date and time the tunnel was last modified.
      example: "2017-06-14T05:20:00Z"
      readOnly: true
    component-value:
      type: object
      properties:
        default:
          $ref: '#/components/schemas/default'
        name:
          $ref: '#/components/schemas/component-value_components-schemas-name'
        unit_price:
          $ref: '#/components/schemas/unit_price'
    component-value_components-schemas-name:
      description: The unique component.
      enum:
      - zones
      - page_rules
      - dedicated_certificates
      - dedicated_certificates_custom
      example: page_rules
    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
    component_values:
      type: array
      description: The list of add-ons subscribed to.
      items:
        $ref: '#/components/schemas/component_value'
    components-schemas-account:
      allOf:
      - $ref: '#/components/schemas/account'
    components-schemas-account_identifier:
      type: string
      description: The account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    components-schemas-action:
      anyOf:
      - type: object
        properties:
          mode:
            $ref: '#/components/schemas/mode'
          response:
            $ref: '#/components/schemas/custom_response'
          timeout:
            $ref: '#/components/schemas/timeout'
      type: object
      description: The action to perform when the threshold of matched traffic within
        the configured period is exceeded.
    components-schemas-address:
      type: string
      description: Address.
      example: 123 Sesame St.
    components-schemas-app_id:
      type: integer
      description: The identifier for this application. There is only one application
        per id.
    components-schemas-asn:
      type: integer
    components-schemas-base:
      required:
      - id
      - modified_on
      properties:
        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
    components-schemas-certificate:
      type: string
      description: The Origin CA certificate. Will be newline-encoded.
      example: |-
        -----BEGIN CERTIFICATE-----
        MIICvDCCAaQCAQAwdzELMAkGA1UEBhMCVVMxDTALBgNVBAgMBFV0YWgxDzANBgNV
        BAcMBkxpbmRvbjEWMBQGA1UECgwNRGlnaUNlcnQgSW5jLjERMA8GA1UECwwIRGln
        aUNlcnQxHTAbBgNVBAMMFGV4YW1wbGUuZGlnaWNlcnQuY29tMIIBIjANBgkqhkiG
        9w0BAQEFAAOCAQ8AMIIBCgKCAQEA8+To7d+2kPWeBv/orU3LVbJwDrSQbeKamCmo
        wp5bqDxIwV20zqRb7APUOKYoVEFFOEQs6T6gImnIolhbiH6m4zgZ/CPvWBOkZc+c
        1Po2EmvBz+AD5sBdT5kzGQA6NbWyZGldxRthNLOs1efOhdnWFuhI162qmcflgpiI
        WDuwq4C9f+YkeJhNn9dF5+owm8cOQmDrV8NNdiTqin8q3qYAHHJRW28glJUCZkTZ
        wIaSR6crBQ8TbYNE0dc+Caa3DOIkz1EOsHWzTx+n0zKfqcbgXi4DJx+C1bjptYPR
        BPZL8DAeWuA8ebudVT44yEp82G96/Ggcf7F33xMxe0yc+Xa6owIDAQABoAAwDQYJ
        KoZIhvcNAQEFBQADggEBAB0kcrFccSmFDmxox0Ne01UIqSsDqHgL+XmHTXJwre6D
        hJSZwbvEtOK0G3+dr4Fs11WuUNt5qcLsx5a8uk4G6AKHMzuhLsJ7XZjgmQXGECpY
        Q4mC3yT3ZoCGpIXbw+iP3lmEEXgaQL0Tx5LFl/okKbKYwIqNiyKWOMj7ZR/wxWg/
        ZDGRs55xuoeLDJ/ZRFf9bI+IaCUd1YrfYcHIl3G87Av+r49YVwqRDT0VDV7uLgqn
        29XI1PpVUNCPQGn9p/eX6Qo7vpDaPybRtA2R7XLKjQaF9oXWeCUqy1hvJac9QFO2
        97Ob1alpHPoZ7mWiEuJwjBPii6a9M9G30nUo39lBi1w=
        -----END CERTIFICATE-----
      readOnly: true
    components-schemas-certificate_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/zone-authenticated-origin-pull'
    components-schemas-certificate_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/schemas-certificateObject'
    components-schemas-collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/web3-hostname'
    components-schemas-colo_name:
      type: string
      description: Scope colo name.
      example: den01
    components-schemas-config:
      type: object
      description: The tunnel configuration and ingress rules in JSON format. For
        syntax and parameters, refer to the [configuration file documentation](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/local/local-management/configuration-file/#file-structure).
    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
    components-schemas-connection:
      type: string
      description: The IdP used to authenticate.
      example: saml
    components-schemas-created:
      type: string
      format: date-time
      description: The date and a time a watermark profile was created.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    components-schemas-created_at:
      type: string
      format: date-time
      description: Shows time of creation.
      example: "2018-08-28T17:26:26Z"
    components-schemas-created_on:
      type: string
      description: The RFC 3339 timestamp of when the list was created.
      example: "2020-01-01T08:00:00Z"
    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
    components-schemas-domain:
      type: string
      description: The domain of the Bookmark application.
      example: example.com
    components-schemas-email:
      type: string
      format: email
      description: The email of the user.
      example: jdoe@example.com
    components-schemas-empty_response:
      allOf:
      - properties:
          result:
            nullable: true
          success:
            type: boolean
            enum:
            - true
            - false
            example: true
    components-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 dedicated 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 a dedicated 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 dedicated 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
    components-schemas-exclude:
      type: array
      items:
        $ref: '#/components/schemas/split_tunnel'
    components-schemas-expires_on:
      type: string
      format: date-time
      description: When the certificate from the authority expires.
      example: "2016-01-01T05:20:00Z"
      readOnly: true
    components-schemas-filters:
      type: object
      example:
        slo:
        - "99.9"
    components-schemas-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
    components-schemas-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
    components-schemas-hostname:
      type: string
      description: Hostname of the Worker Domain.
      example: foo.example.com
    components-schemas-id:
      type: string
      description: Identifier for the tail.
      example: 03dc9f77817b488fb26c5861ec18f791
    components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/tsig_components-schemas-identifier'
    components-schemas-identifier:
      type: string
      description: Token identifier tag.
      example: ed17574386854bf78a67040be0a770b0
      readOnly: true
      maxLength: 32
    components-schemas-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
    components-schemas-ip:
      type: string
      description: The IP address of the authenticating user.
      example: 198.41.129.166
    components-schemas-ips:
      type: array
      description: A list of CIDRs to restrict ingress connections.
      items:
        type: string
        description: The IPv4 CIDR or IPv6 CIDR. IPv6 CIDRs are limited to a maximum
          of /109. IPv4 CIDRs are limited to a maximum of /25.
        example: 192.0.2.1/32
    components-schemas-kind:
      type: string
      description: The type of the membership.
      enum:
      - zone
      - account
      example: zone
    components-schemas-match:
      type: string
      description: The wirefilter expression to match devices.
      example: user.identity == "test@cloudflare.com"
      maxLength: 500
    components-schemas-member:
      type: object
      required:
      - id
      - name
      - email
      - status
      - roles
      properties:
        email:
          $ref: '#/components/schemas/email'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/member_components-schemas-name'
        roles:
          type: array
          description: Roles assigned to this Member.
          items:
            $ref: '#/components/schemas/schemas-role'
        status:
          description: A member's status in the organization.
          enum:
          - accepted
          - invited
          example: accepted
    components-schemas-metadata:
      type: string
      description: Arbitrary JSON to be associated with a key/value pair.
      example: '{"someMetadataKey": "someMetadataValue"}'
    components-schemas-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"
    components-schemas-modified:
      type: string
      format: date-time
      description: The date and time the live input was last modified.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    components-schemas-modified_on:
      type: string
      format: date-time
      description: When the certificate was last modified.
      example: "2014-01-01T05:20:00Z"
      readOnly: true
    components-schemas-modified_tunnels_collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              modified:
                type: boolean
                example: true
              modified_interconnects:
                type: array
                items:
                  $ref: '#/components/schemas/interconnect'
    components-schemas-monitor:
      type: object
      properties:
        allow_insecure:
          $ref: '#/components/schemas/allow_insecure'
        consecutive_down:
          $ref: '#/components/schemas/consecutive_down'
        consecutive_up:
          $ref: '#/components/schemas/consecutive_up'
        created_on:
          $ref: '#/components/schemas/timestamp'
        description:
          $ref: '#/components/schemas/monitor_components-schemas-description'
        expected_body:
          $ref: '#/components/schemas/expected_body'
        expected_codes:
          $ref: '#/components/schemas/schemas-expected_codes'
        follow_redirects:
          $ref: '#/components/schemas/follow_redirects'
        header:
          $ref: '#/components/schemas/header'
        id:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
        interval:
          $ref: '#/components/schemas/interval'
        method:
          $ref: '#/components/schemas/schemas-method'
        modified_on:
          $ref: '#/components/schemas/timestamp'
        path:
          $ref: '#/components/schemas/path'
        port:
          $ref: '#/components/schemas/monitor_components-schemas-port'
        probe_zone:
          $ref: '#/components/schemas/probe_zone'
        retries:
          $ref: '#/components/schemas/retries'
        timeout:
          $ref: '#/components/schemas/schemas-timeout'
        type:
          $ref: '#/components/schemas/monitor_components-schemas-type'
    components-schemas-name:
      type: string
      description: Role Name.
      example: Organization Admin
      readOnly: true
      maxLength: 120
    components-schemas-pattern:
      type: object
      title: Pattern
      description: A pattern that matches an entry
      required:
      - regex
      properties:
        regex:
          type: string
          description: The regex pattern.
          example: ^4[0-9]{6,}$
        validation:
          type: string
          description: Validation algorithm for the pattern. This algorithm will get
            run on potential matches, and if it returns false, the entry will not
            be matched.
          enum:
          - luhn
          example: luhn
    components-schemas-paused:
      type: boolean
      description: When true, indicates that the rule is currently paused.
      example: false
    components-schemas-policies:
      type: object
      properties:
        alert_type:
          $ref: '#/components/schemas/alert_type'
        created:
          $ref: '#/components/schemas/timestamp'
        description:
          $ref: '#/components/schemas/policies_components-schemas-description'
        enabled:
          $ref: '#/components/schemas/policies_components-schemas-enabled'
        filters:
          $ref: '#/components/schemas/components-schemas-filters'
        id:
          $ref: '#/components/schemas/uuid'
        mechanisms:
          $ref: '#/components/schemas/mechanisms'
        modified:
          $ref: '#/components/schemas/timestamp'
        name:
          $ref: '#/components/schemas/policies_components-schemas-name-2'
    components-schemas-port:
      type: integer
      description: 'Port number to connect to for the health check. Required for TCP,
        UDP, and SMTP checks. HTTP and HTTPS checks should only define the port when
        using a non-standard port (HTTP: default 80, HTTPS: default 443).'
      default: 0
    components-schemas-precedence:
      type: number
      description: The precedence of the policy. Lower values indicate higher precedence.
        Policies will be evaluated in ascending order of this field.
      example: 100
    components-schemas-priority:
      type: number
      description: Priority of the routing rule.
      default: 0
      minimum: 0
    components-schemas-query:
      allOf:
      - $ref: '#/components/schemas/query'
      - properties:
          dimensions:
            example:
            - namespaceId
            items:
              enum:
              - namespaceId
          filters:
            example: namespaceId==a4e8cbb7-1b58-4990-925e-e026d40c4c64
          metrics:
            default: '["storedBytes"]'
            example:
            - storedBytes
            - storedKeys
            items:
              enum:
              - storedBytes
              - storedKeys
          sort:
            example:
            - +storedBytes
            - -namespaceId
    components-schemas-ratelimit:
      properties:
        action:
          $ref: '#/components/schemas/components-schemas-action'
        bypass:
          $ref: '#/components/schemas/bypass'
        description:
          $ref: '#/components/schemas/components-schemas-description'
        disabled:
          $ref: '#/components/schemas/disabled'
        id:
          $ref: '#/components/schemas/rate-limits_components-schemas-id'
        match:
          $ref: '#/components/schemas/match'
        period:
          $ref: '#/components/schemas/period'
        threshold:
          $ref: '#/components/schemas/threshold'
    components-schemas-ref:
      type: string
      description: The reference of the rule (the rule ID by default).
      example: my_ref
    components-schemas-response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/ip-list'
    components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/zone_components-schemas-zone'
    components-schemas-response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    components-schemas-result:
      allOf:
      - $ref: '#/components/schemas/schemas-result'
      - properties:
          data:
            example:
            - metrics:
              - - 2
                - 4
              - - 16
                - 32
          max:
            example:
              readKiB: 32
              requests: 4
          min:
            example:
              readKiB: 16
              requests: 2
          query:
            $ref: '#/components/schemas/schemas-query'
          totals:
            example:
              readKiB: 48
              requests: 6
    components-schemas-rule:
      oneOf:
      - $ref: '#/components/schemas/anomaly_rule'
      - $ref: '#/components/schemas/traditional_deny_rule'
      - $ref: '#/components/schemas/traditional_allow_rule'
      type: object
    components-schemas-rules:
      type: array
      description: The list of rules in the ruleset.
      items:
        $ref: '#/components/schemas/rules_components-schemas-rule'
    components-schemas-ruleset:
      properties:
        description:
          example: ""
        id:
          example: 2f2feab2026849078ba485f918791bdc
        kind:
          example: zone
        name:
          example: default
        phase:
          example: http_custom_errors
        rules:
          type: array
          description: The rules in the ruleset.
          items:
            $ref: '#/components/schemas/custom-error-responses_components-schemas-rule'
    components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/tsig'
    components-schemas-state:
      description: The custom page state.
      enum:
      - default
      - customized
      example: default
    components-schemas-status:
      type: string
      description: Whether the user is a member of the organization or has an inivitation
        pending.
      enum:
      - member
      - invited
      example: member
    components-schemas-target:
      type: string
      description: Target gateway of the hostname.
      enum:
      - ethereum
      - ipfs
      - ipfs_universal_path
      - polygon
      example: ipfs
    components-schemas-ttl:
      type: integer
      description: Time To Live (TTL) in number of hops of the GRE tunnel.
      default: 64
    components-schemas-tunnel_modified_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              modified:
                type: boolean
                example: true
              modified_interconnect:
                type: object
    components-schemas-tunnel_single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              interconnect:
                type: object
    components-schemas-tunnel_update_request:
      type: object
      properties:
        description:
          $ref: '#/components/schemas/interconnect_components-schemas-description'
        gre:
          $ref: '#/components/schemas/gre'
        interface_address:
          $ref: '#/components/schemas/interface_address'
        mtu:
          $ref: '#/components/schemas/schemas-mtu'
    components-schemas-tunnels_collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              interconnects:
                type: array
                items:
                  $ref: '#/components/schemas/interconnect'
    components-schemas-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
      example: full
    components-schemas-updated_at:
      type: string
      format: date-time
      description: Last updated.
      example: "2018-08-28T17:26:26Z"
    components-schemas-uploaded_on:
      type: string
      format: date-time
      description: The time when the certificate was uploaded.
      example: "2019-10-28T18:11:23.37411Z"
    components-schemas-url:
      type: string
      format: uri
      description: URL(s) to filter submissions results by
      example: https://www.cloudflare.com
    components-schemas-uuid:
      type: string
      description: The policy ID.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
    components-schemas-validation_method:
      type: object
      required:
      - validation_method
      properties:
        validation_method:
          $ref: '#/components/schemas/validation_method_definition'
    components-schemas-value:
      type: string
      enum:
      - flexible
      - full
      - strict
      example: strict
    components-schemas-version:
      type: object
      description: The version of the analyzed script.
      properties:
        fetched_at:
          $ref: '#/components/schemas/fetched_at'
        hash:
          $ref: '#/components/schemas/hash'
        js_integrity_score:
          $ref: '#/components/schemas/js_integrity_score'
    components-schemas-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:
        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/common_components-schemas-identifier'
        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
          readOnly: true
          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
    condition:
      type: object
      properties:
        request.ip:
          $ref: '#/components/schemas/request.ip'
    config:
      type: array
      items:
        $ref: '#/components/schemas/hostname_certid_input'
    config_components-schemas-account_identifier:
      example: 6f91088a406011ed95aed352566e8d4c
    config_request:
      oneOf:
      - $ref: '#/components/schemas/workspace_one_config_request'
      - $ref: '#/components/schemas/crowdstrike_config_request'
      - $ref: '#/components/schemas/uptycs_config_request'
      - $ref: '#/components/schemas/intune_config_request'
      type: object
      description: The configuration object containing third party integration information.
      example:
        api_url: https://as123.awmdm.com/API
        auth_url: https://na.uemauth.vmwservices.com/connect/token
        client_id: example client id
        client_secret: example client secret
    config_response:
      oneOf:
      - $ref: '#/components/schemas/workspace_one_config_response'
      type: object
      description: The configuration object containing third party integration information.
      example:
        api_url: https://as123.awmdm.com/API
        auth_url: https://na.uemauth.vmwservices.com/connect/token
        client_id: example client id
    config_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    config_src:
      type: string
      description: Indicates if this is a locally or remotely configured tunnel. If
        `local`, manage the tunnel using a YAML file on the origin machine. If `cloudflare`,
        manage the tunnel on the Zero Trust dashboard or using the [Cloudflare Tunnel
        configuration](https://api.cloudflare.com/#cloudflare-tunnel-configuration-properties)
        endpoint.
      enum:
      - local
      - cloudflare
      default: local
      example: cloudflare
    config_version:
      type: integer
      description: The version of the remote tunnel configuration. Used internally
        to sync cloudflared with the Zero Trust dashboard.
    configuration:
      type: object
      properties:
        auth_id_characteristics:
          $ref: '#/components/schemas/characteristics'
    configurations:
      anyOf:
      - $ref: '#/components/schemas/schemas-ip_configuration'
      - $ref: '#/components/schemas/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/schemas-ip_configuration'
        - $ref: '#/components/schemas/schemas-cidr_configuration'
    connect_components-schemas-created:
      type: string
      format: date-time
      description: The date and time the live input was created.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    connected:
      type: boolean
      description: A flag indicating whether the given zone is connected to the Railgun.
      default: false
      example: true
    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
    connection_collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/schemas-connection'
    connection_components-schemas-created_on:
      type: string
      format: date-time
      description: When the connection was created.
      example: "2017-06-14T00:00:00Z"
      readOnly: true
    connection_components-schemas-enabled:
      type: boolean
      description: A value indicating whether the connection is enabled or not.
      default: false
      example: true
    connection_components-schemas-identifier:
      type: string
      description: Connection identifier tag.
      example: c4a7362d577a6c3019a474fd6f485821
      readOnly: true
      maxLength: 32
    connection_components-schemas-modified_on:
      type: string
      format: date-time
      description: When the connection was last modified.
      example: "2017-06-14T05:20:00Z"
      readOnly: true
    connection_components-schemas-zone:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/properties-name'
    connection_id:
      type: string
      description: UUID of the Cloudflare Tunnel connection.
      example: 1bedc50d-42b3-473c-b108-ff3d10c0d925
      readOnly: true
      maxLength: 36
    connection_single_id_response:
      allOf:
      - $ref: '#/components/schemas/connection_single_response'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/connection_components-schemas-identifier'
    connection_single_request:
      type: object
      required:
      - zone
      properties:
        enabled:
          $ref: '#/components/schemas/connection_components-schemas-enabled'
        zone:
          properties:
            id:
              $ref: '#/components/schemas/common_components-schemas-identifier'
    connection_single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    connections:
      type: array
      description: The Cloudflare Tunnel connections between your origin and Cloudflare's
        edge.
      items:
        $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-connection'
    conns_active_at:
      type: string
      format: date-time
      description: Timestamp of when the tunnel established at least one connection
        to Cloudflare's edge. If `null`, the tunnel is inactive.
      example: "2009-11-10T23:00:00Z"
      nullable: true
    conns_inactive_at:
      type: string
      format: date-time
      description: Timestamp of when the tunnel became inactive (no connections to
        Cloudflare's edge). If `null`, the tunnel is active.
      example: "2009-11-10T23:00:00Z"
      nullable: true
    consecutive_down:
      type: integer
      description: To be marked unhealthy the monitored origin must fail this healthcheck
        N consecutive times.
      default: 0
    consecutive_fails:
      type: integer
      description: The number of consecutive fails required from a health check before
        changing the health to unhealthy.
      default: 1
    consecutive_successes:
      type: integer
      description: The number of consecutive successes required from a health check
        before changing the health to healthy.
      default: 1
    consecutive_up:
      type: integer
      description: To be marked healthy the monitored origin must pass this healthcheck
        N consecutive times.
      default: 0
    consumer:
      type: object
      properties:
        created_on:
          readOnly: true
        environment:
          readOnly: true
        queue_name:
          readOnly: true
        service:
          readOnly: true
        settings:
          type: object
          properties:
            batch_size:
              $ref: '#/components/schemas/batch_size'
            max_retries:
              $ref: '#/components/schemas/max_retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/max_wait_time_ms'
    consumer_created:
      type: object
      properties:
        created_on:
          readOnly: true
        dead_letter_queue:
          $ref: '#/components/schemas/dlq_name'
        environment:
          readOnly: true
        queue_name:
          readOnly: true
        script_name:
          readOnly: true
        settings:
          type: object
          properties:
            batch_size:
              $ref: '#/components/schemas/batch_size'
            max_retries:
              $ref: '#/components/schemas/max_retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/max_wait_time_ms'
    consumer_name:
      type: string
      example: example-consumer
    consumer_updated:
      type: object
      properties:
        created_on:
          readOnly: true
        dead_letter_queue:
          example: updated-example-dlq
        environment:
          readOnly: true
        queue_name:
          readOnly: true
        script_name:
          readOnly: true
        settings:
          type: object
          properties:
            batch_size:
              type: number
              example: 100
            max_retries:
              $ref: '#/components/schemas/max_retries'
            max_wait_time_ms:
              $ref: '#/components/schemas/max_wait_time_ms'
    contact_identifier:
      type: string
      description: Contact Identifier.
      example: ea95132c15732412d22c1476fa83f27a
      readOnly: true
      maxLength: 32
    contact_properties:
      type: object
      required:
      - first_name
      - last_name
      - address
      - city
      - state
      - zip
      - country
      - phone
      - organization
      properties:
        address:
          $ref: '#/components/schemas/components-schemas-address'
        address2:
          $ref: '#/components/schemas/address2'
        city:
          $ref: '#/components/schemas/city'
        country:
          $ref: '#/components/schemas/country'
        email:
          $ref: '#/components/schemas/email'
        fax:
          $ref: '#/components/schemas/fax'
        first_name:
          $ref: '#/components/schemas/first_name'
        id:
          $ref: '#/components/schemas/contact_identifier'
        last_name:
          $ref: '#/components/schemas/last_name'
        organization:
          $ref: '#/components/schemas/schemas-organization'
        phone:
          $ref: '#/components/schemas/telephone'
        state:
          $ref: '#/components/schemas/contacts_components-schemas-state'
        zip:
          $ref: '#/components/schemas/zipcode'
    contacts:
      allOf:
      - $ref: '#/components/schemas/contact_properties'
      type: object
    contacts_components-schemas-state:
      type: string
      description: State.
      example: TX
    content:
      type: string
      description: DNS record content.
      example: 127.0.0.1
    content_categories:
      description: Current content categories.
      example:
      - id: 155
        name: Technology
        super_category_id: 26
    content_list_action:
      type: string
      description: Behavior of the content list.
      enum:
      - block
      example: block
    content_list_details:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/content_list_action'
    content_list_details_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/content_list_details'
    content_list_entries:
      type: array
      description: Content list entries.
      items:
        $ref: '#/components/schemas/content_list_entry'
    content_list_entry:
      type: object
      description: Content list entry to be blocked.
      properties:
        content:
          $ref: '#/components/schemas/content_list_entry_content'
        created_on:
          $ref: '#/components/schemas/timestamp'
        description:
          $ref: '#/components/schemas/content_list_entry_description'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        modified_on:
          $ref: '#/components/schemas/timestamp'
        type:
          $ref: '#/components/schemas/content_list_entry_type'
    content_list_entry_collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: object
            properties:
              entries:
                $ref: '#/components/schemas/content_list_entries'
    content_list_entry_content:
      type: string
      description: CID or content path of content to block.
      example: QmPZ9gcCEpqKTo6aq61g2nXGUhM4iCL3ewB6LDXZCtioEB
      maxLength: 500
    content_list_entry_create_request:
      type: object
      required:
      - type
      - content
      properties:
        content:
          $ref: '#/components/schemas/content_list_entry_content'
        description:
          $ref: '#/components/schemas/content_list_entry_description'
        type:
          $ref: '#/components/schemas/content_list_entry_type'
    content_list_entry_description:
      type: string
      description: An optional description of the content list entry.
      example: this is my content list entry
      maxLength: 500
    content_list_entry_single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/content_list_entry'
    content_list_entry_type:
      type: string
      description: Type of content list entry to block.
      enum:
      - cid
      - content_path
      example: cid
    content_list_update_request:
      type: object
      required:
      - action
      - entries
      properties:
        action:
          $ref: '#/components/schemas/content_list_action'
        entries:
          $ref: '#/components/schemas/content_list_entries'
    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
    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
    cors_headers:
      type: object
      properties:
        allow_all_headers:
          $ref: '#/components/schemas/allow_all_headers'
        allow_all_methods:
          $ref: '#/components/schemas/allow_all_methods'
        allow_all_origins:
          $ref: '#/components/schemas/allow_all_origins'
        allow_credentials:
          $ref: '#/components/schemas/allow_credentials'
        allowed_headers:
          $ref: '#/components/schemas/allowed_headers'
        allowed_methods:
          $ref: '#/components/schemas/allowed_methods'
        allowed_origins:
          $ref: '#/components/schemas/allowed_origins'
        max_age:
          $ref: '#/components/schemas/max_age'
    count:
      type: number
      description: The number of items in the List.
      example: 20
      readOnly: true
    country:
      type: string
      description: The country in which the user lives.
      example: US
      nullable: true
      maxLength: 30
    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
    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
    create:
      type: object
      required:
      - email
      - roles
      properties:
        email:
          $ref: '#/components/schemas/email'
        roles:
          type: array
          description: Array of roles associated with this member.
          items:
            $ref: '#/components/schemas/role_components-schemas-identifier'
        status:
          enum:
          - accepted
          - pending
          default: pending
    create_custom_profile_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/custom_profile'
    create_custom_profiles:
      required:
      - profiles
      properties:
        profiles:
          type: array
          items:
            $ref: '#/components/schemas/new_custom_profile'
          required:
          - name
          - entries
    create_destination_address_properties:
      type: object
      required:
      - email
      properties:
        email:
          $ref: '#/components/schemas/email'
    create_input_request:
      properties:
        defaultCreator:
          $ref: '#/components/schemas/live_input_default_creator'
        meta:
          $ref: '#/components/schemas/live_input_metadata'
        recording:
          $ref: '#/components/schemas/live_input_recording_settings'
    create_output_request:
      required:
      - url
      - streamKey
      properties:
        enabled:
          $ref: '#/components/schemas/output_enabled'
        streamKey:
          $ref: '#/components/schemas/output_streamKey'
        url:
          $ref: '#/components/schemas/output_url'
    create_payload:
      type: object
      required:
      - name
      - policies
      properties:
        condition:
          $ref: '#/components/schemas/condition'
        expires_on:
          $ref: '#/components/schemas/expires_on'
        name:
          $ref: '#/components/schemas/name'
        not_before:
          $ref: '#/components/schemas/not_before'
        policies:
          $ref: '#/components/schemas/policies'
    create_rename_namespace_body:
      type: object
      required:
      - title
      properties:
        title:
          $ref: '#/components/schemas/namespace_title'
    create_request:
      type: object
      required:
      - name
      - target
      properties:
        description:
          $ref: '#/components/schemas/web3-hostname_components-schemas-description'
        dnslink:
          $ref: '#/components/schemas/dnslink'
        name:
          $ref: '#/components/schemas/web3-hostname_components-schemas-name'
        target:
          $ref: '#/components/schemas/components-schemas-target'
    create_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              client_id:
                $ref: '#/components/schemas/client_id'
              client_secret:
                $ref: '#/components/schemas/client_secret'
              created_at:
                $ref: '#/components/schemas/timestamp'
              id:
                description: The ID of the service token.
              name:
                $ref: '#/components/schemas/service-tokens_components-schemas-name'
              updated_at:
                $ref: '#/components/schemas/timestamp'
    create_rule:
      required:
      - action
      - expression
      properties:
        action:
          $ref: '#/components/schemas/rule_action'
        description:
          $ref: '#/components/schemas/rule_description'
        enabled:
          $ref: '#/components/schemas/rule_enabled'
        expression:
          $ref: '#/components/schemas/rule_expression'
    create_rule_properties:
      type: object
      required:
      - actions
      - matchers
      properties:
        actions:
          $ref: '#/components/schemas/actions'
        enabled:
          $ref: '#/components/schemas/rules_components-schemas-enabled'
        matchers:
          $ref: '#/components/schemas/matchers'
        name:
          $ref: '#/components/schemas/rules_components-schemas-name'
        priority:
          $ref: '#/components/schemas/components-schemas-priority'
    create_ruleset:
      type: object
      description: A ruleset object.
      required:
      - name
      - kind
      - phase
      - rules
      properties:
        description:
          $ref: '#/components/schemas/rulesets_components-schemas-description'
        kind:
          $ref: '#/components/schemas/schemas-kind'
        name:
          $ref: '#/components/schemas/rulesets_components-schemas-name'
        phase:
          $ref: '#/components/schemas/phase'
        rules:
          $ref: '#/components/schemas/create_update_rules'
    create_update_rule:
      type: object
      description: A rule object.
      required:
      - expression
      - action
      properties:
        action:
          $ref: '#/components/schemas/rules_components-schemas-action'
        action_parameters:
          $ref: '#/components/schemas/action_parameters'
        description:
          $ref: '#/components/schemas/rules_components-schemas-description'
        enabled:
          $ref: '#/components/schemas/rules_components-schemas-enabled-2'
        expression:
          $ref: '#/components/schemas/schemas-expression'
        logging:
          $ref: '#/components/schemas/logging'
        ref:
          $ref: '#/components/schemas/components-schemas-ref'
    create_update_rules:
      type: array
      description: The list of rules in the ruleset.
      items:
        anyOf:
        - $ref: '#/components/schemas/create_update_rule'
        - description: The unique ID of a rule.
    created:
      type: string
      format: date-time
      description: The date and time the destination address has been created.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    created-on:
      type: string
      format: date-time
      example: "2014-01-01T05:20:00.12345Z"
      readOnly: true
    created_at:
      type: string
      format: date-time
      description: This is the time the hostname was created.
      example: "2020-02-06T18:11:23.531995Z"
    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
    creator:
      type: string
      description: A user-defined identifier for the media creator.
      example: creator-id_abcde12345
      maxLength: 64
    cron-trigger-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
            properties:
              schedules:
                type: array
                items:
                  properties:
                    created_on:
                      readOnly: true
                    cron:
                      readOnly: true
                    modified_on:
                      readOnly: true
    crowdstrike_config_request:
      type: object
      required:
      - api_url
      - customer_id
      - client_id
      - client_secret
      properties:
        api_url:
          type: string
          description: The Crowdstrike API URL.
          example: https://api.us-2.crowdstrike.com
        client_id:
          type: string
          description: The Crowdstrike client ID.
          example: example client id
        client_secret:
          type: string
          description: The Crowdstrike client secret.
          example: example client secret
        customer_id:
          type: string
          description: The Crowdstrike customer ID.
          example: example customer id
    csr:
      type: string
      description: The Certificate Signing Request (CSR). Must be newline-encoded.
      example: |-
        -----BEGIN CERTIFICATE REQUEST-----
        MIICxzCCAa8CAQAwSDELMAkGA1UEBhMCVVMxFjAUBgNVBAgTDVNhbiBGcmFuY2lz
        Y28xCzAJBgNVBAcTAkNBMRQwEgYDVQQDEwtleGFtcGxlLm5ldDCCASIwDQYJKoZI
        hvcNAQEBBQADggEPADCCAQoCggEBALxejtu4b+jPdFeFi6OUsye8TYJQBm3WfCvL
        Hu5EvijMO/4Z2TImwASbwUF7Ir8OLgH+mGlQZeqyNvGoSOMEaZVXcYfpR1hlVak8
        4GGVr+04IGfOCqaBokaBFIwzclGZbzKmLGwIQioNxGfqFm6RGYGA3be2Je2iseBc
        N8GV1wYmvYE0RR+yWweJCTJ157exyRzu7sVxaEW9F87zBQLyOnwXc64rflXslRqi
        g7F7w5IaQYOl8yvmk/jEPCAha7fkiUfEpj4N12+oPRiMvleJF98chxjD4MH39c5I
        uOslULhrWunfh7GB1jwWNA9y44H0snrf+xvoy2TcHmxvma9Eln8CAwEAAaA6MDgG
        CSqGSIb3DQEJDjErMCkwJwYDVR0RBCAwHoILZXhhbXBsZS5uZXSCD3d3dy5leGFt
        cGxlLm5ldDANBgkqhkiG9w0BAQsFAAOCAQEAcBaX6dOnI8ncARrI9ZSF2AJX+8mx
        pTHY2+Y2C0VvrVDGMtbBRH8R9yMbqWtlxeeNGf//LeMkSKSFa4kbpdx226lfui8/
        auRDBTJGx2R1ccUxmLZXx4my0W5iIMxunu+kez+BDlu7bTT2io0uXMRHue4i6quH
        yc5ibxvbJMjR7dqbcanVE10/34oprzXQsJ/VmSuZNXtjbtSKDlmcpw6To/eeAJ+J
        hXykcUihvHyG4A1m2R6qpANBjnA0pHexfwM/SgfzvpbvUg0T1ubmer8BgTwCKIWs
        dcWYTthM51JIqRBfNqy4QcBnX+GY05yltEEswQI55wdiS3CjTTA67sdbcQ==
        -----END CERTIFICATE REQUEST-----
    currency:
      type: string
      description: The monetary unit in which pricing information is displayed.
      example: USD
      readOnly: true
    current:
      type: number
      description: Cloudflare Images current usage.
      example: 1000
      readOnly: true
    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
    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
    current_registrar:
      type: string
      description: Shows name of current registrar.
      example: Cloudflare
    cursor:
      type: string
      description: Opaque token indicating the position from which to continue when
        requesting the next set of records if the amount of list results was limited
        by the limit parameter. A valid value for the cursor can be obtained from
        the cursors object in the result_info structure.
      example: 6Ck1la0VxJ0djhidm1MdX2FyDGxLKVeeHZZmORS_8XeSuhz9SjIJRaSa2lnsF01tQOHrfTGAP3R5X1Kv5iVUuMbNKhWNAXHOl6ePB0TUL8nw
    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/bundle_method'
        expires_on:
          $ref: '#/components/schemas/components-schemas-expires_on'
        geo_restrictions:
          $ref: '#/components/schemas/geo_restrictions'
        hosts:
          $ref: '#/components/schemas/hosts'
        id:
          $ref: '#/components/schemas/custom-certificate_components-schemas-identifier'
        issuer:
          $ref: '#/components/schemas/issuer'
        keyless_server:
          $ref: '#/components/schemas/keyless-certificate'
        modified_on:
          $ref: '#/components/schemas/components-schemas-modified_on'
        policy:
          $ref: '#/components/schemas/policy'
        priority:
          $ref: '#/components/schemas/schemas-priority'
        signature:
          $ref: '#/components/schemas/signature'
        status:
          $ref: '#/components/schemas/custom-certificate_components-schemas-status'
        uploaded_on:
          $ref: '#/components/schemas/uploaded_on'
        zone_id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
    custom-certificate_components-schemas-identifier:
      type: string
      description: Custom certificate identifier tag.
      example: 2458ce5a-0c35-4c7f-82c7-8e9487d3ff60
      readOnly: true
      maxLength: 36
    custom-certificate_components-schemas-status:
      description: Status of the zone's custom SSL.
      enum:
      - active
      - expired
      - deleted
      - pending
      - initializing
      example: active
      readOnly: true
    custom-certificate_components-schemas-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
    custom-error-responses_components-schemas-rule:
      properties:
        action:
          example: serve_error
        action_parameters:
          $ref: '#/components/schemas/action_parameters_serve_error'
        description:
          example: Change error response based on geolocation
        expression:
          example: ip.geoip.country eq "AL"
        id:
          example: 3a03d665bac047339bb530ecb439a90d
        version:
          example: "1"
    custom-hostname:
      allOf:
      - $ref: '#/components/schemas/customhostname'
      type: object
      required:
      - id
      - hostname
      - ssl
      properties:
        hostname:
          $ref: '#/components/schemas/hostname'
        id:
          $ref: '#/components/schemas/custom-hostname_components-schemas-identifier'
        ssl:
          $ref: '#/components/schemas/schemas-ssl'
    custom-hostname_components-schemas-identifier:
      type: string
      description: Custom hostname identifier tag.
      example: 0d89c70d-ad9f-4843-b99f-6cc0252067e9
      readOnly: true
      minLength: 36
      maxLength: 36
    custom-hostname_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
    custom-ns_components-schemas-identifier:
      type: string
      description: Account identifier tag.
      example: 372e67954025e0ba6aaa6d586b9e0b59
      readOnly: true
      maxLength: 32
    custom-pages_components-schemas-identifier:
      description: The name of the custom page type.
      enum:
      - basic_challenge
      - managed_challenge
      - waf_block
      - ratelimit_block
      - country_challenge
      - ip_block
      - under_attack
      - 500_errors
      - 1000_errors
      example: basic_challenge
      readOnly: true
    custom-pages_components-schemas-identifier-2:
      description: The name of the custom page type.
      enum:
      - basic_challenge
      - managed_challenge
      - waf_block
      - country_challenge
      - ip_block
      - under_attack
      - ratelimit_block
      - 500_errors
      - 1000_errors
      example: basic_challenge
      readOnly: true
    custom_deny_message:
      type: string
      description: The custom error message shown to a user when they are denied access
        to the application.
    custom_deny_url:
      type: string
      description: The custom URL a user is redirected to when they are denied access
        to the application.
    custom_entry:
      type: object
      title: Custom entry
      description: A custom entry that matches a profile
      properties:
        created_at:
          $ref: '#/components/schemas/timestamp'
        enabled:
          type: boolean
          description: Whether the entry is enabled or not.
          example: true
        id:
          $ref: '#/components/schemas/entry_id'
        name:
          type: string
          description: The name of the entry.
          example: Credit card (Visa)
        pattern:
          $ref: '#/components/schemas/components-schemas-pattern'
        profile_id:
          description: ID of the parent profile
        updated_at:
          $ref: '#/components/schemas/timestamp'
    custom_hostname_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/custom-hostname'
    custom_hostname_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    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.
    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
    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
    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}}'
    custom_pages_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              type: object
    custom_pages_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    custom_profile:
      type: object
      title: Custom profile
      properties:
        created_at:
          $ref: '#/components/schemas/timestamp'
        description:
          type: string
          description: The description of the profile.
          example: A standard CVV card number
        entries:
          type: array
          description: The entries for this profile.
          items:
            $ref: '#/components/schemas/custom_entry'
        id:
          $ref: '#/components/schemas/profile_id'
        name:
          type: string
          description: The name of the profile.
          example: Generic CVV Card Number
        type:
          type: string
          description: The type of the profile.
          enum:
          - custom
          example: custom
        updated_at:
          $ref: '#/components/schemas/timestamp'
    custom_profile_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            allOf:
            - $ref: '#/components/schemas/custom_profile'
    custom_response:
      anyOf:
      - type: object
        properties:
          body:
            $ref: '#/components/schemas/body'
          content_type:
            $ref: '#/components/schemas/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.
    customer_gre_endpoint:
      type: string
      description: The IP address assigned to the customer side of the GRE tunnel.
      example: 203.0.113.1
    customer_ipsec_endpoint:
      type: string
      description: The IP address assigned to the customer side of the IPsec tunnel.
      example: 203.0.113.1
    customhostname:
      properties:
        created_at:
          $ref: '#/components/schemas/created_at'
        custom_metadata:
          $ref: '#/components/schemas/custom_metadata'
        custom_origin_server:
          $ref: '#/components/schemas/custom_origin_server'
        custom_origin_sni:
          $ref: '#/components/schemas/custom_origin_sni'
        hostname:
          $ref: '#/components/schemas/hostname'
        id:
          $ref: '#/components/schemas/custom-hostname_components-schemas-identifier'
        ownership_verification:
          $ref: '#/components/schemas/ownership_verification'
        ownership_verification_http:
          $ref: '#/components/schemas/ownership_verification_http'
        ssl:
          $ref: '#/components/schemas/schemas-ssl'
        status:
          $ref: '#/components/schemas/custom-hostname_components-schemas-status'
        verification_errors:
          $ref: '#/components/schemas/verification_errors'
    dashboard:
      type: object
      title: Dashboard response
      description: Totals and timeseries data.
      properties:
        timeseries:
          $ref: '#/components/schemas/timeseries'
        totals:
          $ref: '#/components/schemas/totals'
    dashboard_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          query:
            $ref: '#/components/schemas/query_response'
          result:
            $ref: '#/components/schemas/dashboard'
    data_points:
      type: integer
      description: The number of data points used for the threshold suggestion calculation.
      readOnly: true
    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/timeseries_by_colo'
          totals:
            $ref: '#/components/schemas/totals_by_colo'
    dataset:
      type: string
      description: Dataset to be pulled.
      example: http_requests
      nullable: true
      maxLength: 256
      pattern: ^[a-zA-Z0-9_\-]*$
    days_until_next_rotation:
      type: number
      description: The number of days until the next key rotation.
      example: 1
      readOnly: true
    decision:
      type: string
      description: The action Access will take if a user matches this policy.
      enum:
      - allow
      - deny
      - non_identity
      - bypass
      example: allow
    default:
      type: number
      description: The default amount allocated.
      example: 5
    default_device_settings_policy:
      type: object
      properties:
        allow_mode_switch:
          $ref: '#/components/schemas/allow_mode_switch'
        allow_updates:
          $ref: '#/components/schemas/allow_updates'
        allowed_to_leave:
          $ref: '#/components/schemas/allowed_to_leave'
        auto_connect:
          $ref: '#/components/schemas/auto_connect'
        captive_portal:
          $ref: '#/components/schemas/captive_portal'
        default:
          type: boolean
          description: Whether the policy will be applied to matching devices.
          example: true
        disable_auto_fallback:
          $ref: '#/components/schemas/disable_auto_fallback'
        enabled:
          type: boolean
          description: Whether the policy will be applied to matching devices.
          example: true
        exclude:
          $ref: '#/components/schemas/components-schemas-exclude'
        fallback_domains:
          $ref: '#/components/schemas/fallback_domains'
        gateway_unique_id:
          $ref: '#/components/schemas/gateway_unique_id'
        include:
          $ref: '#/components/schemas/schemas-include'
        service_mode_v2:
          $ref: '#/components/schemas/service_mode_v2'
        support_url:
          $ref: '#/components/schemas/support_url'
        switch_locked:
          $ref: '#/components/schemas/switch_locked'
    default_device_settings_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            $ref: '#/components/schemas/default_device_settings_policy'
    default_mode:
      description: The default action/mode of a rule.
      enum:
      - disable
      - simulate
      - block
      - challenge
      example: block
      readOnly: true
    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.
    default_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          errors:
            type: array
            items: {}
          messages:
            type: array
            items: {}
    default_sni:
      type: string
      description: If you have legacy TLS clients which do not send the TLS server
        name indicator, then you can specify one default SNI on the map. If Cloudflare
        receives a TLS handshake from a client without an SNI, it will respond with
        the default SNI on those IPs. The default SNI can be any valid zone or subdomain
        owned by the account.
      example: '*.example.com'
      nullable: true
    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
      default: en-US
      example: es-ES
    delegated_account_identifier:
      type: string
      description: Account identifier for the account to which prefix is being delegated.
      example: b1946ac92492d2347c6235b4d2611184
      readOnly: true
      maxLength: 32
    delegation_identifier:
      type: string
      description: Delegation identifier tag.
      example: d933b1530bc56c9953cf8ce166da8004
      readOnly: true
      maxLength: 32
    delete_advanced_certificate_pack_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/certificate-packs_components-schemas-identifier'
    delete_dnssec_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: string
            example: ""
    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.
    deleted:
      type: boolean
      description: When true, indicates that the firewall rule was deleted.
      example: true
    deleted-filter:
      required:
      - id
      - deleted
      properties:
        deleted:
          $ref: '#/components/schemas/deleted'
        id:
          $ref: '#/components/schemas/filters_components-schemas-id'
    deleted_at:
      type: string
      format: date-time
      description: Date of deletion, if any.
      nullable: true
      readOnly: true
    deleted_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: string
            example: ""
    deployment-list-response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result_info:
            type: object
            properties:
              count:
                example: 1
              page:
                example: 1
              per_page:
                example: 100
              total_count:
                example: 1
      - properties:
          result:
            type: array
            items:
              type: object
    deployment-new-deployment:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/deployments'
    deployment-response-details:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/deployments'
    deployment-response-logs:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
            example:
              data:
              - line: Cloning repository...
                ts: "2021-04-20T19:35:29.0749819Z"
              - line: From https://github.com/cloudflare/example
                ts: "2021-04-20T19:35:30.0749819Z"
              - line: ' * branch            209c5bb11d89533f426b2f8469bcae12fdccf71b
                  -> FETCH_HEAD'
                ts: "2021-04-20T19:35:30.0749819Z"
              - line: ""
                ts: "2021-04-20T19:35:30.0749819Z"
              - line: HEAD is now at 209c5bb Update index.html
                ts: "2021-04-20T19:35:30.0749819Z"
              - line: ""
                ts: "2021-04-20T19:35:30.0749819Z"
              - line: ""
                ts: "2021-04-20T19:35:30.0749819Z"
              - line: 'Success: Finished cloning repository files'
                ts: "2021-04-20T19:35:30.0749819Z"
              - line: Installing dependencies
                ts: "2021-04-20T19:35:59.0749819Z"
              - line: Python version set to 2.7
                ts: "2021-04-20T19:35:59.0931208Z"
              - line: v12.18.0 is already installed.
                ts: "2021-04-20T19:36:02.2369501Z"
              - line: Now using node v12.18.0 (npm v6.14.4)
                ts: "2021-04-20T19:36:02.6028886Z"
              - line: Started restoring cached build plugins
                ts: "2021-04-20T19:36:02.624555Z"
              - line: Finished restoring cached build plugins
                ts: "2021-04-20T19:36:02.6340688Z"
              - line: Attempting ruby version 2.7.1, read from environment
                ts: "2021-04-20T19:36:02.963095Z"
              - line: Using ruby version 2.7.1
                ts: "2021-04-20T19:36:04.2236084Z"
              - line: Using PHP version 5.6
                ts: "2021-04-20T19:36:04.5450152Z"
              - line: 5.2 is already installed.
                ts: "2021-04-20T19:36:04.5740509Z"
              - line: Using Swift version 5.2
                ts: "2021-04-20T19:36:04.577035Z"
              - line: Installing Hugo 0.54.0
                ts: "2021-04-20T19:36:04.5771615Z"
              - line: 'Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64
                  BuildDate: 2019-02-01T10:04:38Z'
                ts: "2021-04-20T19:36:05.4786868Z"
              - line: Started restoring cached go cache
                ts: "2021-04-20T19:36:05.4794366Z"
              - line: Finished restoring cached go cache
                ts: "2021-04-20T19:36:05.481977Z"
              - line: go version go1.14.4 linux/amd64
                ts: "2021-04-20T19:36:05.9049776Z"
              - line: go version go1.14.4 linux/amd64
                ts: "2021-04-20T19:36:05.9086053Z"
              - line: Installing missing commands
                ts: "2021-04-20T19:36:05.9163568Z"
              - line: Verify run directory
                ts: "2021-04-20T19:36:05.9163934Z"
              - line: 'Executing user command: echo "skipping build step: no build
                  command specified"'
                ts: "2021-04-20T19:36:05.9164636Z"
              - line: 'skipping build step: no build command specified'
                ts: "2021-04-20T19:36:05.9165087Z"
              - line: Finished
                ts: "2021-04-20T19:36:05.917412Z"
              includes_container_logs: true
              total: 30
    deployment-response-stage-logs:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
            example:
              data:
              - id: 15
                message: Installing dependencies
                timestamp: "2021-04-20T19:35:59.0749819Z"
              - id: 16
                message: Python version set to 2.7
                timestamp: "2021-04-20T19:35:59.0931208Z"
              - id: 17
                message: v12.18.0 is already installed.
                timestamp: "2021-04-20T19:36:02.2369501Z"
              - id: 18
                message: Now using node v12.18.0 (npm v6.14.4)
                timestamp: "2021-04-20T19:36:02.6028886Z"
              - id: 19
                message: Started restoring cached build plugins
                timestamp: "2021-04-20T19:36:02.624555Z"
              - id: 20
                message: Finished restoring cached build plugins
                timestamp: "2021-04-20T19:36:02.6340688Z"
              - id: 21
                message: Attempting ruby version 2.7.1, read from environment
                timestamp: "2021-04-20T19:36:02.963095Z"
              - id: 22
                message: Using ruby version 2.7.1
                timestamp: "2021-04-20T19:36:04.2236084Z"
              - id: 23
                message: Using PHP version 5.6
                timestamp: "2021-04-20T19:36:04.5450152Z"
              - id: 24
                message: 5.2 is already installed.
                timestamp: "2021-04-20T19:36:04.5740509Z"
              - id: 25
                message: Using Swift version 5.2
                timestamp: "2021-04-20T19:36:04.577035Z"
              - id: 26
                message: Installing Hugo 0.54.0
                timestamp: "2021-04-20T19:36:04.5771615Z"
              - id: 27
                message: 'Hugo Static Site Generator v0.54.0-B1A82C61A/extended linux/amd64
                  BuildDate: 2019-02-01T10:04:38Z'
                timestamp: "2021-04-20T19:36:05.4786868Z"
              - id: 28
                message: Started restoring cached go cache
                timestamp: "2021-04-20T19:36:05.4794366Z"
              - id: 29
                message: Finished restoring cached go cache
                timestamp: "2021-04-20T19:36:05.481977Z"
              - id: 30
                message: go version go1.14.4 linux/amd64
                timestamp: "2021-04-20T19:36:05.9049776Z"
              - id: 31
                message: go version go1.14.4 linux/amd64
                timestamp: "2021-04-20T19:36:05.9086053Z"
              - id: 32
                message: Installing missing commands
                timestamp: "2021-04-20T19:36:05.9163568Z"
              - id: 33
                message: Verify run directory
                timestamp: "2021-04-20T19:36:05.9163934Z"
              - id: 34
                message: 'Executing user command: echo "skipping build step: no build
                  command specified"'
                timestamp: "2021-04-20T19:36:05.9164636Z"
              - id: 35
                message: 'skipping build step: no build command specified'
                timestamp: "2021-04-20T19:36:05.9165087Z"
              - id: 36
                message: Finished
                timestamp: "2021-04-20T19:36:05.917412Z"
              end: 37
              ended_on: "2021-04-20T19:36:06.38889Z"
              name: build
              start: 0
              started_on: "2021-04-20T19:35:58.238757Z"
              status: success
              total: 37
    deployment_configs:
      type: object
      description: Configs for deployments in a project.
      properties:
        preview:
          anyOf:
          - $ref: '#/components/schemas/deployment_configs_values'
          type: object
          description: Configs for preview deploys.
        production:
          anyOf:
          - $ref: '#/components/schemas/deployment_configs_values'
          type: object
          description: Configs for production deploys.
    deployment_configs_values:
      type: object
      properties:
        compatibility_date:
          type: string
          description: Compatibility date used for Pages Functions.
          example: "2022-01-01"
        compatibility_flags:
          type: array
          description: Compatibility flags used for Pages Functions.
          example:
          - url_standard
        d1_databases:
          type: object
          description: D1 databases used for Pages Functions.
          nullable: true
          properties:
            D1_BINDING:
              type: object
              description: D1 binding.
              example:
                id: 445e2955-951a-43f8-a35b-a4d0c8138f63
              properties:
                id:
                  type: string
                  description: UUID of the D1 database.
                  example: 445e2955-951a-43f8-a35b-a4d0c8138f63
        durable_object_namespaces:
          type: object
          description: Durabble Object namespaces used for Pages Functions.
          nullable: true
          properties:
            DO_BINDING:
              type: object
              description: Durabble Object binding.
              example:
                namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3
              properties:
                namespace_id:
                  type: string
                  description: ID of the Durabble Object namespace.
                  example: 5eb63bbbe01eeed093cb22bb8f5acdc3
        env_vars:
          type: object
          description: Environment variables for build configs.
          nullable: true
          properties:
            ENVIRONMENT_VARIABLE:
              type: object
              description: Environment variable.
              example:
                type: plain_text
                value: hello world
              properties:
                type:
                  type: string
                  description: The type of environment variable (plain text or secret)
                  enum:
                  - plain_text
                  - secret_text
                value:
                  type: string
                  description: Environment variable value.
        kv_namespaces:
          type: object
          description: KV namespaces used for Pages Functions.
          properties:
            KV_BINDING:
              type: object
              description: KV binding.
              example:
                namespace_id: 5eb63bbbe01eeed093cb22bb8f5acdc3
              properties:
                namespace_id:
                  type: string
                  description: ID of the KV namespace.
                  example: 5eb63bbbe01eeed093cb22bb8f5acdc3
        r2_buckets:
          type: object
          description: R2 buckets used for Pages Functions.
          nullable: true
          properties:
            R2_BINDING:
              type: object
              description: R2 binding.
              example:
                name: some-bucket
              properties:
                name:
                  type: string
                  description: Name of the R2 bucket.
                  example: some-bucket
        service_bindings:
          type: object
          description: Services used for Pages Functions.
          nullable: true
          properties:
            SERVICE_BINDING:
              type: object
              description: Service binding.
              example:
                environment: production
                service: example-worker
              properties:
                environment:
                  type: string
                  description: The Service environment.
                service:
                  type: string
                  description: The Service name.
    deployment_identifier:
      type: string
      example: bcf48806-b317-4351-9ee7-36e7d557d4de
      readOnly: true
      maxLength: 36
    deployment_stage_name:
      type: string
      description: Deployment stage name.
      example: deploy
      pattern: queued|initialize|clone_repo|build|deploy
    deployments:
      type: object
      properties:
        aliases:
          type: array
          description: A list of alias URLs pointing to this deployment.
          example:
          - https://branchname.projectname.pages.dev
          nullable: true
          readOnly: true
          items: {}
        build_config:
          readOnly: true
        created_on:
          type: string
          format: date-time
          description: When the deployment was created.
          example: "2021-03-09T00:55:03.923456Z"
          readOnly: true
        deployment_trigger:
          type: object
          description: Info about what caused the deployment.
          readOnly: true
          properties:
            metadata:
              type: object
              description: Additional info about the trigger.
              properties:
                branch:
                  type: string
                  description: Where the trigger happened.
                  example: main
                  readOnly: true
                commit_hash:
                  type: string
                  description: Hash of the deployment trigger commit.
                  example: ad9ccd918a81025731e10e40267e11273a263421
                  readOnly: true
                commit_message:
                  type: string
                  description: Message of the deployment trigger commit.
                  example: Update index.html
                  readOnly: true
            type:
              type: string
              description: What caused the deployment.
              example: ad_hoc
              readOnly: true
              pattern: push|ad_hoc
        env_vars:
          type: object
          description: A dict of env variables to build this deploy.
          example:
            BUILD_VERSION:
              value: "3.3"
            ENV:
              value: STAGING
          readOnly: true
        environment:
          type: string
          description: Type of deploy.
          example: preview
          readOnly: true
          pattern: preview|production
        id:
          type: string
          description: Id of the deployment.
          example: f64788e9-fccd-4d4a-a28a-cb84f88f6
          readOnly: true
        is_skipped:
          type: boolean
          description: If the deployment has been skipped.
          example: true
          readOnly: true
        latest_stage:
          readOnly: true
        modified_on:
          type: string
          format: date-time
          description: When the deployment was last modified.
          example: 2021-03-09T00:58:59.045655
          readOnly: true
        project_id:
          type: string
          description: Id of the project.
          example: 7b162ea7-7367-4d67-bcde-1160995d5
          readOnly: true
        project_name:
          type: string
          description: Name of the project.
          example: ninjakittens
          readOnly: true
        short_id:
          type: string
          description: Short Id (8 character) of the deployment.
          example: f64788e9
          readOnly: true
        source:
          readOnly: true
        stages:
          type: array
          description: List of past stages.
          example:
          - ended_on: "2021-06-03T15:39:03.134378Z"
            name: queued
            started_on: "2021-06-03T15:38:15.608194Z"
            status: active
          - ended_on: null
            name: initialize
            started_on: null
            status: idle
          - ended_on: null
            name: clone_repo
            started_on: null
            status: idle
          - ended_on: null
            name: build
            started_on: null
            status: idle
          - ended_on: null
            name: deploy
            started_on: null
            status: idle
          readOnly: true
          items:
            $ref: '#/components/schemas/stage'
        url:
          type: string
          description: The live URL to view this deployment.
          example: https://f64788e9.ninjakittens.pages.dev
          readOnly: true
    deployments-list-response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          items:
            type: array
            example:
            - id: bcf48806-b317-4351-9ee7-36e7d557d4de
              metadata:
                author_email: user@example.com
                author_id: 408cbcdfd4dda4617efef40b04d168a1
                created_on: "2022-11-15T18:25:44.442097Z"
                modified_on: "2022-11-15T18:25:44.442097Z"
                source: api
              number: 2
            - id: 18f97339-c287-4872-9bdd-e2135c07ec12
              metadata:
                author_email: user@example.com
                author_id: 408cbcdfd4dda4617efef40b04d168a1
                created_on: "2022-11-08T17:30:56.968096Z"
                modified_on: "2022-11-08T17:30:56.968096Z"
                source: api
              number: 1
            items: {}
          latest:
            type: object
            example:
              id: bcf48806-b317-4351-9ee7-36e7d557d4de
              metadata:
                author_email: user@example.com
                author_id: 408cbcdfd4dda4617efef40b04d168a1
                created_on: "2022-11-15T18:25:44.442097Z"
                modified_on: "2022-11-15T18:25:44.442097Z"
                source: api
              number: 2
              resources:
                bindings:
                - json: example_binding
                  name: JSON_VAR
                  type: json
                script:
                  etag: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794
                  handlers:
                  - fetch
                  last_deployed_from: api
                script_runtime:
                  usage_model: bundled
    deployments-single-response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          id:
            type: string
            example: 18f97339-c287-4872-9bdd-e2135c07ec12
          metadata:
            type: object
            example:
              author_email: user@example.com
              author_id: 408cbcdfd4dda4617efef40b04d168a1
              created_on: "2022-11-08T17:19:29.176266Z"
              modified_on: "2022-11-08T17:19:29.176266Z"
              source: api
          number:
            type: number
            example: 1
          resources:
            type: object
            example:
              bindings:
              - json: example_binding
                name: JSON_VAR
                type: json
              script:
                etag: 13a3240e8fb414561b0366813b0b8f42b3e6cfa0d9e70e99835dae83d0d8a794
                handlers:
                - fetch
                last_deployed_from: api
              script_runtime:
                usage_model: bundled
    deprecate_any_requests:
      type: boolean
      description: Deprecate the response to ANY requests.
      example: true
    description:
      type: string
      description: Description of role's permissions.
      example: Administrative access to the entire Organization
      readOnly: true
    destination_address_identifier:
      type: string
      description: Destination address identifier.
      example: ea95132c15732412d22c1476fa83f27a
      readOnly: true
      maxLength: 32
    destination_address_properties:
      type: object
      properties:
        created:
          $ref: '#/components/schemas/created'
        email:
          $ref: '#/components/schemas/email'
        modified:
          $ref: '#/components/schemas/modified'
        tag:
          $ref: '#/components/schemas/destination_address_identifier'
        verified:
          $ref: '#/components/schemas/verified'
    destination_address_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    destination_addresses_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/addresses'
          result_info:
            type: object
            properties:
              count:
                example: 1
              page:
                example: 1
              per_page:
                example: 20
              total_count:
                example: 1
    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
    destination_exists_response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            properties:
              exists:
                type: boolean
                example: false
    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
    development_mode:
      allOf:
      - $ref: '#/components/schemas/schemas-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/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.
    development_mode_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    device-posture-integrations:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/config_response'
        id:
          $ref: '#/components/schemas/device-posture-integrations_components-schemas-uuid'
        interval:
          $ref: '#/components/schemas/schemas-interval'
        name:
          $ref: '#/components/schemas/device-posture-integrations_components-schemas-name'
        type:
          $ref: '#/components/schemas/device-posture-integrations_components-schemas-type'
    device-posture-integrations_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            nullable: true
    device-posture-integrations_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    device-posture-integrations_components-schemas-name:
      type: string
      description: The name of the Device Posture Integration.
      example: My Workspace One Integration
    device-posture-integrations_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/device-posture-integrations'
    device-posture-integrations_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/device-posture-integrations'
    device-posture-integrations_components-schemas-type:
      type: string
      description: The type of Device Posture Integration.
      enum:
      - workspace_one
      - crowdstrike_s2s
      - uptycs
      - intune
      example: workspace_one
    device-posture-integrations_components-schemas-uuid:
      type: string
      description: API uuid tag.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
    device-posture-rules:
      type: object
      properties:
        description:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-description'
        expiration:
          $ref: '#/components/schemas/schemas-expiration'
        id:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-uuid'
        input:
          $ref: '#/components/schemas/schemas-input'
        match:
          $ref: '#/components/schemas/schemas-match'
        name:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-name'
        schedule:
          $ref: '#/components/schemas/schedule'
        type:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-type'
    device-posture-rules_components-schemas-description:
      type: string
      description: The description of the Device Posture Rule.
      example: The rule for admin serial numbers
    device-posture-rules_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/device-posture-rules_components-schemas-uuid'
    device-posture-rules_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    device-posture-rules_components-schemas-name:
      type: string
      description: The name of the Device Posture Rule.
      example: Admin Serial Numbers
    device-posture-rules_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/device-posture-rules'
    device-posture-rules_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/device-posture-rules'
    device-posture-rules_components-schemas-type:
      type: string
      description: The type of Device Posture Rule.
      enum:
      - file
      - application
      - serial_number
      - tanium
      - gateway
      - warp
      example: file
    device-posture-rules_components-schemas-uuid:
      type: string
      description: API uuid tag.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
    device_posture:
      type: string
      description: The wirefilter expression to be used for device posture check matching.
      example: any(device_posture.checks.passed[*] in {"1308749e-fcfb-4ebc-b051-fe022b632644"})
    device_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    device_settings_policy:
      type: object
      properties:
        allow_mode_switch:
          $ref: '#/components/schemas/allow_mode_switch'
        allow_updates:
          $ref: '#/components/schemas/allow_updates'
        allowed_to_leave:
          $ref: '#/components/schemas/allowed_to_leave'
        auto_connect:
          $ref: '#/components/schemas/auto_connect'
        captive_portal:
          $ref: '#/components/schemas/captive_portal'
        default:
          $ref: '#/components/schemas/schemas-default'
        disable_auto_fallback:
          $ref: '#/components/schemas/disable_auto_fallback'
        enabled:
          type: boolean
          description: Whether the policy will be applied to matching devices.
          example: true
        exclude:
          $ref: '#/components/schemas/components-schemas-exclude'
        fallback_domains:
          $ref: '#/components/schemas/fallback_domains'
        gateway_unique_id:
          $ref: '#/components/schemas/gateway_unique_id'
        include:
          $ref: '#/components/schemas/schemas-include'
        match:
          $ref: '#/components/schemas/components-schemas-match'
        name:
          type: string
          description: The name of the device settings policy.
          example: Allow Developers
          maxLength: 100
        policy_id:
          $ref: '#/components/schemas/uuid'
        precedence:
          $ref: '#/components/schemas/components-schemas-precedence'
        service_mode_v2:
          $ref: '#/components/schemas/service_mode_v2'
        support_url:
          $ref: '#/components/schemas/support_url'
        switch_locked:
          $ref: '#/components/schemas/switch_locked'
    device_settings_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            $ref: '#/components/schemas/device_settings_policy'
    device_settings_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/device_settings_policy'
    devices:
      type: object
      properties:
        created:
          $ref: '#/components/schemas/devices_components-schemas-created'
        deleted:
          $ref: '#/components/schemas/schemas-deleted'
        device_type:
          $ref: '#/components/schemas/platform'
        id:
          $ref: '#/components/schemas/devices_components-schemas-uuid'
        ip:
          $ref: '#/components/schemas/devices_components-schemas-ip'
        key:
          $ref: '#/components/schemas/schemas-key'
        last_seen:
          $ref: '#/components/schemas/last_seen'
        mac_address:
          $ref: '#/components/schemas/mac_address'
        manufacturer:
          $ref: '#/components/schemas/manufacturer'
        model:
          $ref: '#/components/schemas/model'
        name:
          $ref: '#/components/schemas/devices_components-schemas-name'
        os_distro_name:
          $ref: '#/components/schemas/os_distro_name'
        os_distro_revision:
          $ref: '#/components/schemas/os_distro_revision'
        os_version:
          $ref: '#/components/schemas/os_version'
        revoked_at:
          $ref: '#/components/schemas/revoked_at'
        serial_number:
          $ref: '#/components/schemas/schemas-serial_number'
        updated:
          $ref: '#/components/schemas/updated'
        user:
          $ref: '#/components/schemas/user'
        version:
          $ref: '#/components/schemas/devices_components-schemas-version'
    devices_components-schemas-created:
      type: string
      format: date-time
      description: When the device was created.
      example: "2017-06-14T00:00:00Z"
    devices_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    devices_components-schemas-ip:
      type: string
      description: IPv4 or IPv6 address.
      example: 1.1.1.1
    devices_components-schemas-name:
      type: string
      description: The device name.
      example: My mobile device
    devices_components-schemas-uuid:
      type: string
      description: Device ID.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
    devices_components-schemas-version:
      type: string
      description: The WARP client version.
      example: 1.0.0
    devices_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/devices'
    dimension_value:
      anyOf:
      - type: object
        description: Dimension value, may contain dimension identifier for drill down.
        required:
        - name
        properties:
          id:
            type: string
            description: Dimension value identifier that can be used for drill down.
          name:
            type: string
            description: Dimension value.
            example: NODATA
      - type: string
        description: Dimension value.
        example: NODATA
    direct_upload_request:
      type: object
      required:
      - maxDurationSeconds
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/allowedOrigins'
        creator:
          $ref: '#/components/schemas/creator'
        expiry:
          type: string
          format: date-time
          description: The date and time after upload when videos will not be accepted.
          default: Now + 30 minutes
          example: "2021-01-02T02:20:00Z"
        maxDurationSeconds:
          type: integer
          description: Calculates the amount of time a video occupies before the video
            is uploaded. Direct uploads occupy minutes of videos on your Stream account
            until they are expired. After upload, the upload duration is used instead.
            If a video longer than the value is uploaded, the video results in an
            error.
          minimum: 1
          maximum: 21600
        requireSignedURLs:
          $ref: '#/components/schemas/requireSignedURLs'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/thumbnailTimestampPct'
        watermark:
          $ref: '#/components/schemas/watermark_at_upload'
    direct_upload_request_v2:
      type: object
      properties:
        expiry:
          type: string
          format: date-time
          description: 'The date after which the upload will not be accepted. Minimum:
            Now + 2 minutes. Maximum: Now + 6 hours.'
          default: Now + 30 minutes
          example: "2021-01-02T02:20:00Z"
        metadata:
          type: object
          description: User modifiable key-value store. Can be used for keeping references
            to another system of record, for managing images.
        requireSignedURLs:
          type: boolean
          description: Indicates whether the image requires a signature token to be
            accessed.
          default: false
          example: true
    direct_upload_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              uid:
                $ref: '#/components/schemas/videos_components-schemas-identifier'
              uploadURL:
                type: string
                description: The URL an unauthenticated upload can use for a single
                  `HTTP POST multipart/form-data` request.
                example: www.example.com/samplepath
              watermark:
                $ref: '#/components/schemas/watermarks'
    direct_upload_response_v2:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              id:
                type: string
                description: Image unique identifier.
                example: e22e9e6b-c02b-42fd-c405-6c32af5fe600
                readOnly: true
                maxLength: 32
              uploadURL:
                type: string
                description: The URL the unauthenticated upload can be performed to
                  using a single HTTP POST (multipart/form-data) request.
                example: https://upload.imagedelivery.net/FxUufywByo0m2v3xhKSiU8/e22e9e6b-c02b-42fd-c405-6c32af5fe600
    disable_auto_fallback:
      type: boolean
      description: If the dns_server field of a fallback domain is not present, the
        client will fall back to a best guess of the default/system DNS resolvers,
        unless this policy option is set.
      example: true
    disable_for_time:
      type: object
      properties:
        "1":
          description: Override code that is valid for 1 hour.
          example: "9106681"
        "3":
          description: Override code that is valid for 3 hours.
          example: "5356247"
        "6":
          description: Override code that is valid for 6 hours.
          example: "9478972"
        "12":
          description: Override code that is valid for 12 hour2.
          example: "3424359"
        "24":
          description: Override code that is valid for 24 hour.2.
          example: "2887634"
    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
    disable_transfer_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/disable_transfer_result'
    disable_transfer_result:
      type: string
      description: The zone transfer status of a primary zone
      example: Disabled
    disabled:
      type: boolean
      description: When true, indicates that the rate limit is currently disabled.
      example: false
    disabled_at:
      type: string
      format: date-time
      description: This field shows up only if the origin is disabled. This field
        is set with the time the origin was disabled.
      readOnly: true
    display_name:
      type: string
      description: Alert type name.
      example: Origin Error Rate Alert
    dlq_name:
      type: string
      example: example-dlq
    dns:
      type: object
      description: The name and type of DNS record for the Spectrum application.
      properties:
        name:
          $ref: '#/components/schemas/dns_name'
        type:
          $ref: '#/components/schemas/dns_type'
    dns-firewall:
      type: object
      required:
      - id
      - name
      - origin_ips
      - dns_firewall_ips
      - minimum_cache_ttl
      - maximum_cache_ttl
      - deprecate_any_requests
      - ecs_fallback
      - modified_on
      properties:
        attack_mitigation:
          $ref: '#/components/schemas/attack_mitigation'
        deprecate_any_requests:
          $ref: '#/components/schemas/deprecate_any_requests'
        dns_firewall_ips:
          $ref: '#/components/schemas/dns_firewall_ips'
        ecs_fallback:
          $ref: '#/components/schemas/ecs_fallback'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        maximum_cache_ttl:
          $ref: '#/components/schemas/maximum_cache_ttl'
        minimum_cache_ttl:
          $ref: '#/components/schemas/minimum_cache_ttl'
        modified_on:
          $ref: '#/components/schemas/schemas-modified_on'
        name:
          $ref: '#/components/schemas/dns-firewall_components-schemas-name'
        negative_cache_ttl:
          $ref: '#/components/schemas/negative_cache_ttl'
        origin_ips:
          $ref: '#/components/schemas/origin_ips'
        ratelimit:
          $ref: '#/components/schemas/ratelimit'
    dns-firewall_components-schemas-name:
      type: string
      description: DNS Firewall Cluster Name.
      example: My Awesome DNS Firewall cluster
      maxLength: 160
    dns-record:
      oneOf:
      - $ref: '#/components/schemas/ARecord'
      - $ref: '#/components/schemas/AAAARecord'
      - $ref: '#/components/schemas/CNAMERecord'
      - $ref: '#/components/schemas/HTTPSRecord'
      - $ref: '#/components/schemas/NSRecord'
      - $ref: '#/components/schemas/MXRecord'
      - $ref: '#/components/schemas/TXTRecord'
      - $ref: '#/components/schemas/LOCRecord'
      - $ref: '#/components/schemas/SRVRecord'
      - $ref: '#/components/schemas/CERTRecord'
      - $ref: '#/components/schemas/DNSKEYRecord'
      - $ref: '#/components/schemas/DSRecord'
      - $ref: '#/components/schemas/NAPTRRecord'
      - $ref: '#/components/schemas/SMIMEARecord'
      - $ref: '#/components/schemas/SSHFPRecord'
      - $ref: '#/components/schemas/SVCBRecord'
      - $ref: '#/components/schemas/TLSARecord'
      - $ref: '#/components/schemas/URIRecord'
      type: object
      required:
      - id
      - type
      - name
      - content
      - proxiable
      - proxied
      - ttl
      - locked
      - zone_name
      - created_on
      - modified_on
    dns-record_components-schemas-base:
      properties:
        content:
          $ref: '#/components/schemas/content'
        created_on:
          type: string
          format: date-time
          description: When the record was created.
          example: "2014-01-01T05:20:00.12345Z"
          readOnly: true
        data:
          type: object
          description: Metadata about the record.
          example: {}
        id:
          $ref: '#/components/schemas/dns-record_components-schemas-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.
          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
        name:
          $ref: '#/components/schemas/dns-record_components-schemas-name'
        proxiable:
          type: boolean
          description: Whether the record can be proxied by Cloudflare or not.
          example: true
          readOnly: true
        proxied:
          $ref: '#/components/schemas/proxied'
        ttl:
          $ref: '#/components/schemas/ttl'
        type:
          $ref: '#/components/schemas/dns-record_components-schemas-type'
        zone_id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        zone_name:
          type: string
          format: hostname
          description: The domain of the record.
          example: example.com
          readOnly: true
    dns-record_components-schemas-identifier:
      type: string
      description: DNS record identifier tag.
      example: 372e67954025e0ba6aaa6d586b9e0b59
      readOnly: true
      maxLength: 32
    dns-record_components-schemas-name:
      type: string
      description: DNS record name (or @ for the zone apex).
      example: example.com
      maxLength: 255
    dns-record_components-schemas-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: A
      readOnly: true
    dns-secondary-primary-zone_components-schemas-identifier:
      example: 269d8f4853475ca241c4e730be286b20
    dns-secondary-primary-zone_components-schemas-name:
      type: string
      description: Zone name.
      example: www.example.com.
    dns-secondary-secondary-zone:
      type: object
      required:
      - id
      - name
      - peers
      - auto_refresh_seconds
      properties:
        auto_refresh_seconds:
          $ref: '#/components/schemas/auto_refresh_seconds'
        id:
          $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-name'
        peers:
          $ref: '#/components/schemas/peers'
    dns-secondary-secondary-zone_components-schemas-identifier:
      example: 269d8f4853475ca241c4e730be286b20
    dns-secondary-secondary-zone_components-schemas-name:
      type: string
      description: Zone name.
      example: www.example.com.
    dns-settings_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/schemas-dns-record'
    dns_firewall_ips:
      type: array
      example:
      - 203.0.113.1
      - 203.0.113.254
      - 2001:DB8:AB::CF
      - 2001:DB8:CD::CF
      items:
        anyOf:
        - type: string
          format: ipv4
          description: Origin DNS Server IPv4 Address.
          example: 203.0.113.1
        - type: string
          format: ipv6
          description: Origin DNS Server IPv6 Address.
          example: 2001:DB8:ab::CF
    dns_firewall_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/dns-firewall'
    dns_firewall_single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/dns-firewall'
    dns_name:
      type: string
      format: hostname
      description: The name of the DNS record associated with the application.
      example: ssh.example.com
    dns_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/dns-record'
    dns_response_import_scan:
      allOf:
      - $ref: '#/components/schemas/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"
    dns_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    dns_ttl:
      type: integer
      description: The TTL of our resolution of your DNS record in seconds.
      minimum: 600
    dns_type:
      type: string
      description: The type of DNS record associated with the application.
      enum:
      - CNAME
      - ADDRESS
      example: CNAME
    dnslink:
      type: string
      description: DNSLink value used if the target is ipfs.
      example: /ipns/onboarding.ipfs.cloudflare.com
    dnssec_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    domain:
      type: object
      properties:
        environment:
          $ref: '#/components/schemas/environment'
        hostname:
          $ref: '#/components/schemas/components-schemas-hostname'
        id:
          $ref: '#/components/schemas/domain_identifier'
        service:
          $ref: '#/components/schemas/service'
        zone_id:
          $ref: '#/components/schemas/zone_identifier'
        zone_name:
          $ref: '#/components/schemas/zone_name'
    domain-history:
      properties:
        categorizations:
          type: array
          items:
            type: object
            properties:
              categories:
                example:
                - id: 155
                  name: Technology
              end:
                type: string
                format: date
                example: "2021-04-30"
              start:
                type: string
                format: date
                example: "2021-04-01"
        domain:
          $ref: '#/components/schemas/schemas-domain_name'
    domain-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result_info:
            type: object
            properties:
              count:
                example: 1
              page:
                example: 1
              per_page:
                example: 100
              total_count:
                example: 1
      - properties:
          result:
            type: array
            items:
              type: object
    domain-response-single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    domain_components-schemas-domain:
      properties:
        additional_information:
          $ref: '#/components/schemas/additional_information'
        application:
          $ref: '#/components/schemas/schemas-application'
        content_categories:
          $ref: '#/components/schemas/content_categories'
        domain:
          $ref: '#/components/schemas/schemas-domain_name'
        popularity_rank:
          $ref: '#/components/schemas/popularity_rank'
        resolves_to_refs:
          $ref: '#/components/schemas/resolves_to_refs'
        risk_score:
          $ref: '#/components/schemas/risk_score'
        risk_types:
          $ref: '#/components/schemas/risk_types'
    domain_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/domain_components-schemas-domain'
    domain_identifier:
      description: Identifer of the Worker Domain.
      example: dbe10b4bc17c295377eabd600e1787fd
    domain_name:
      type: string
      description: Name of the domain.
      example: this-is-my-domain-01.com
      pattern: ^[a-z0-9][a-z0-9-]*$
    domain_names:
      type: array
      description: List of domain names.
      example:
      - cloudflare.com
      - cloudflare.net
      items:
        type: string
    domain_properties:
      type: object
      properties:
        available:
          $ref: '#/components/schemas/schemas-available'
        can_register:
          $ref: '#/components/schemas/can_register'
        created_at:
          $ref: '#/components/schemas/components-schemas-created_at'
        current_registrar:
          $ref: '#/components/schemas/current_registrar'
        expires_at:
          $ref: '#/components/schemas/expires_at'
        id:
          $ref: '#/components/schemas/schemas-domain_identifier'
        locked:
          $ref: '#/components/schemas/locked'
        registrant_contact:
          $ref: '#/components/schemas/registrant_contact'
        registry_statuses:
          $ref: '#/components/schemas/registry_statuses'
        supported_tld:
          $ref: '#/components/schemas/supported_tld'
        transfer_in:
          $ref: '#/components/schemas/transfer_in'
        updated_at:
          $ref: '#/components/schemas/components-schemas-updated_at'
    domain_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/domains'
    domain_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    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
    domain_update_properties:
      type: object
      properties:
        auto_renew:
          $ref: '#/components/schemas/auto_renew'
        locked:
          $ref: '#/components/schemas/locked'
        name_servers:
          $ref: '#/components/schemas/name_servers'
        privacy:
          $ref: '#/components/schemas/privacy'
    domains:
      allOf:
      - $ref: '#/components/schemas/domain_properties'
      type: object
    domains-post:
      example:
        name: example.com
    domains_components-schemas-account_identifier:
      example: 9a7806061c88ada191ed06f989cc3dac
    downloadedFrom:
      type: string
      description: The source URL for a downloaded image. If the watermark profile
        was created via direct upload, this field is null.
      example: https://company.com/logo.png
      readOnly: true
    downloads_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    duration:
      type: number
      description: The duration of the plan subscription.
      example: 1
    early_hints:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - early_hints
            example: early_hints
          value:
            $ref: '#/components/schemas/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.
    early_hints_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    ecs-support:
      type: boolean
      description: Set if the location needs to resolve EDNS queries.
      example: false
    ecs_fallback:
      type: boolean
      description: Forward client IP (resolver) subnet if no EDNS Client Subnet is
        sent.
      example: false
    edge_cache_ttl:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - edge_cache_ttl
            example: edge_cache_ttl
          value:
            $ref: '#/components/schemas/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.
    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
    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
    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
    effect:
      type: string
      description: Allow or deny operations against the resources.
      enum:
      - allow
      - deny
      example: allow
    either_profile_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            anyOf:
            - $ref: '#/components/schemas/predefined_profile'
            - $ref: '#/components/schemas/custom_profile'
    eligibility:
      type: object
      properties:
        eligible:
          $ref: '#/components/schemas/eligible'
        ready:
          $ref: '#/components/schemas/ready'
        type:
          $ref: '#/components/schemas/eligibility_components-schemas-type'
    eligibility_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: object
            example:
              email:
                eligible: true
                ready: true
                type: email
    eligibility_components-schemas-type:
      type: string
      description: Determines type of delivery mechanism.
      enum:
      - email
      - pagerduty
      - webhook
      example: email
    eligible:
      type: boolean
      description: Determines whether or not the account is eligible for the delivery
        mechanism.
      example: true
    email:
      type: string
      description: The contact email address of the user.
      example: user@example.com
      maxLength: 90
    email-settings_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    email_obfuscation:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - email_obfuscation
            example: email_obfuscation
          value:
            $ref: '#/components/schemas/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).
    email_obfuscation_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "on"
    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
    empty_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            maxItems: 0
            items: {}
    enable_binding_cookie:
      type: boolean
      description: Enables the binding cookie, which increases security against compromised
        authorization tokens and CSRF attacks.
      default: false
    enable_transfer_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/enable_transfer_result'
    enable_transfer_result:
      type: string
      description: The zone transfer status of a primary zone
      example: Enabled
    enabled:
      type: boolean
      description: Flag that indicates if the job was enabled.
      example: false
    enabled_download_phase:
      type: boolean
      description: Set to enable antivirus scan on downloads.
      example: false
    enabled_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              enabled:
                $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled'
    enabled_upload_phase:
      type: boolean
      description: Set to enable antivirus scan on uploads.
      example: false
    end_time_seconds:
      type: integer
      description: Specifies the end time for the video clip in seconds.
      readOnly: true
    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: ^/.*$
    entry_id:
      allOf:
      - $ref: '#/components/schemas/uuid'
      description: The ID for this entry
      example: 719d1215-260f-41d0-8c32-eb320ad107f7
    environment:
      type: string
      description: Worker environment associated with the zone and hostname.
      example: production
    error:
      type: string
      description: Errors resulting from collecting traceroute from colo to target.
      enum:
      - ""
      - 'Could not gather traceroute data: Code 1'
      - 'Could not gather traceroute data: Code 2'
      - 'Could not gather traceroute data: Code 3'
      - 'Could not gather traceroute data: Code 4'
      example: ""
    errorReasonCode:
      type: string
      description: Specifies why the video failed to encode. This field is empty if
        the video is not in an `error` state. Preferred for programmatic use.
      example: ERR_NON_VIDEO
      readOnly: true
    errorReasonText:
      type: string
      description: Specifies why the video failed to encode using a human readable
        error message in English. This field is empty if the video is not in an `error`
        state.
      example: The file was not recognized as a valid video file.
      readOnly: true
    estimated_queued_users:
      type: integer
    estimated_total_active_users:
      type: integer
    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
    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
    event_details_custom_page_html:
      type: string
      example: '{{#waitTimeKnown}} {{waitTime}} mins {{/waitTimeKnown}} {{^waitTimeKnown}}
        Event is prequeueing / Queue all enabled {{/waitTimeKnown}}'
    event_details_disable_session_renewal:
      type: boolean
      example: false
    event_details_new_users_per_minute:
      type: integer
    event_details_queueing_method:
      type: string
      example: random
    event_details_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/event_details_result'
    event_details_result:
      type: object
      properties:
        created_on:
          $ref: '#/components/schemas/timestamp'
        custom_page_html:
          $ref: '#/components/schemas/event_details_custom_page_html'
        description:
          $ref: '#/components/schemas/event_description'
        disable_session_renewal:
          $ref: '#/components/schemas/event_details_disable_session_renewal'
        event_end_time:
          $ref: '#/components/schemas/event_end_time'
        event_start_time:
          $ref: '#/components/schemas/event_start_time'
        id:
          $ref: '#/components/schemas/event_id'
        modified_on:
          $ref: '#/components/schemas/timestamp'
        name:
          $ref: '#/components/schemas/event_name'
        new_users_per_minute:
          $ref: '#/components/schemas/event_details_new_users_per_minute'
        prequeue_start_time:
          $ref: '#/components/schemas/event_prequeue_start_time'
        queueing_method:
          $ref: '#/components/schemas/event_details_queueing_method'
        session_duration:
          $ref: '#/components/schemas/event_details_session_duration'
        shuffle_at_event_start:
          $ref: '#/components/schemas/event_shuffle_at_event_start'
        suspended:
          $ref: '#/components/schemas/event_suspended'
        total_active_users:
          $ref: '#/components/schemas/event_details_total_active_users'
    event_details_session_duration:
      type: integer
    event_details_total_active_users:
      type: integer
    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
    event_end_time:
      type: string
      description: An ISO 8601 timestamp that marks the end of the event.
      example: "2021-09-28T17:00:00.000Z"
    event_id:
      example: 25756b2dfe6e378a06b033b670413757
    event_id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/event_id'
    event_name:
      type: string
      description: A unique name to identify the event. Only alphanumeric characters,
        hyphens and underscores are allowed.
      example: production_webinar_event
    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: 2.147483647e+09
    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
    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
    event_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/event_result'
    event_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/event_result'
    event_result:
      type: object
      properties:
        created_on:
          $ref: '#/components/schemas/timestamp'
        custom_page_html:
          $ref: '#/components/schemas/event_custom_page_html'
        description:
          $ref: '#/components/schemas/event_description'
        disable_session_renewal:
          $ref: '#/components/schemas/event_disable_session_renewal'
        event_end_time:
          $ref: '#/components/schemas/event_end_time'
        event_start_time:
          $ref: '#/components/schemas/event_start_time'
        id:
          $ref: '#/components/schemas/event_id'
        modified_on:
          $ref: '#/components/schemas/timestamp'
        name:
          $ref: '#/components/schemas/event_name'
        new_users_per_minute:
          $ref: '#/components/schemas/event_new_users_per_minute'
        prequeue_start_time:
          $ref: '#/components/schemas/event_prequeue_start_time'
        queueing_method:
          $ref: '#/components/schemas/event_queueing_method'
        session_duration:
          $ref: '#/components/schemas/event_session_duration'
        shuffle_at_event_start:
          $ref: '#/components/schemas/event_shuffle_at_event_start'
        suspended:
          $ref: '#/components/schemas/event_suspended'
        total_active_users:
          $ref: '#/components/schemas/event_total_active_users'
    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
    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
    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"
    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
    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: 2.147483647e+09
    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: {}
    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/rule_components-schemas-rule'
    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. This
        parameter is only valid for HTTP and HTTPS monitors.
      example: alive
    expected_codes:
      type: string
      description: The expected HTTP response code or code range of the health check.
        This parameter is only valid for HTTP and HTTPS monitors.
      default: "200"
      example: 2xx
    expiration:
      type: number
      description: The time, measured in number of seconds since the UNIX epoch, at
        which the key should expire.
      example: 1.578435e+09
    expiration_ttl:
      type: number
      description: The number of seconds for which the key should be visible before
        it expires. At least 60.
      example: 300
    expires_at:
      type: string
      format: date-time
      description: Shows when domain name registration expires.
      example: "2019-08-28T23:59:59Z"
    expires_on:
      type: string
      format: date-time
      description: The expiration time on or after which the JWT MUST NOT be accepted
        for processing.
      example: "2020-01-01T00:00:00Z"
    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
    externally_managed:
      type: boolean
      description: Indicates whether this plan is managed externally.
      default: false
      example: false
    fail_closed:
      type: boolean
      description: Block requests for files that cannot be scanned.
      example: false
    failed_login_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              type: object
              properties:
                expiration:
                  type: integer
                metadata:
                  type: object
                  example:
                    app_name: Test App
                    aud: 39691c1480a2352a18ece567debc2b32552686cbd38eec0887aa18d5d3f00c04
                    datetime: "2022-02-02T21:54:34.914Z"
                    ray_id: 6d76a8a42ead4133
                    user_email: test@cloudflare.com
                    user_uuid: 57171132-e453-4ee8-b2a5-8cbaad333207
    failure_reason:
      type: string
      description: The current failure reason if status is unhealthy.
      example: ""
      readOnly: true
    fallback_domain:
      type: object
      required:
      - suffix
      properties:
        description:
          type: string
          description: A description of the fallback domain, displayed in the client
            UI.
          example: Domain bypass for local development
          maxLength: 100
        dns_server:
          type: array
          description: A list of IP addresses to handle domain resolution.
          items: {}
        suffix:
          type: string
          description: The domain suffix to match when resolving locally.
          example: example.com
    fallback_domain_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/fallback_domain'
    fallback_domains:
      type: array
      items:
        $ref: '#/components/schemas/fallback_domain'
    fallback_origin_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    fallback_pool:
      description: The pool ID to use when all other pools are detected as unhealthy.
    fax:
      type: string
      description: Contact fax number.
      example: 123-867-5309
    feature_app_props:
      type: object
      properties:
        allowed_idps:
          $ref: '#/components/schemas/allowed_idps'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/auto_redirect_to_identity'
        domain:
          $ref: '#/components/schemas/schemas-domain'
        name:
          $ref: '#/components/schemas/apps_components-schemas-name'
        session_duration:
          $ref: '#/components/schemas/session_duration'
        type:
          $ref: '#/components/schemas/apps_components-schemas-type'
    features:
      anyOf:
      - $ref: '#/components/schemas/thresholds'
      type: object
      readOnly: true
    fetched_at:
      type: string
      description: The timestamp of when the script was last fetched.
      nullable: true
    fields_response:
      type: object
      properties:
        key:
          type: string
          example: value
    filename:
      type: string
      description: Image file name.
      example: logo.png
      readOnly: true
      maxLength: 32
    filter:
      type: object
      properties:
        description:
          $ref: '#/components/schemas/filters_components-schemas-description'
        expression:
          $ref: '#/components/schemas/expression'
        id:
          $ref: '#/components/schemas/filters_components-schemas-id'
        paused:
          $ref: '#/components/schemas/filters_components-schemas-paused'
        ref:
          $ref: '#/components/schemas/schemas-ref'
    filter-delete-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/filter'
              - type: object
                required:
                - id
    filter-delete-response-single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        required:
        - result
        properties:
          result:
            allOf:
            - $ref: '#/components/schemas/filter'
            - type: object
              required:
              - id
    filter-no-id:
      required:
      - pattern
      - enabled
      properties:
        enabled:
          $ref: '#/components/schemas/filters_components-schemas-enabled'
        pattern:
          $ref: '#/components/schemas/schemas-pattern'
    filter-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/filters'
    filter-response-single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/filters'
    filter-rule-base:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/firewall-rules_components-schemas-action'
        description:
          $ref: '#/components/schemas/firewall-rules_components-schemas-description'
        id:
          $ref: '#/components/schemas/firewall-rules_components-schemas-id'
        paused:
          $ref: '#/components/schemas/firewall-rules_components-schemas-paused'
        priority:
          $ref: '#/components/schemas/firewall-rules_components-schemas-priority'
        products:
          $ref: '#/components/schemas/products'
        ref:
          $ref: '#/components/schemas/ref'
    filter-rule-response:
      allOf:
      - $ref: '#/components/schemas/filter-rule-base'
      - properties:
          filter:
            oneOf:
            - $ref: '#/components/schemas/filter'
            - $ref: '#/components/schemas/deleted-filter'
      type: object
    filter-rules-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        required:
        - result
        properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/filter-rule-response'
              - type: object
                required:
                - id
                - filter
                - action
                - paused
    filter-rules-response-collection-delete:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        required:
        - result
        properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/filter-rule-response'
              - type: object
                required:
                - id
    filter-rules-single-response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        required:
        - result
        properties:
          result:
            allOf:
            - $ref: '#/components/schemas/filter-rule-response'
            - type: object
              required:
              - id
              - filter
              - action
              - paused
    filter-rules-single-response-delete:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        required:
        - result
        properties:
          result:
            allOf:
            - $ref: '#/components/schemas/filter-rule-response'
            - type: object
              required:
              - id
    filter_options:
      type: object
      description: Filter options for a particular resource type (pool or origin).
        Use null to reset.
      nullable: true
      properties:
        disable:
          type: boolean
          description: If set true, disable notifications for this type of resource
            (pool or origin).
          default: false
        healthy:
          type: boolean
          description: If present, send notifications only for this health status
            (e.g. false for only DOWN events). Use null to reset (all events).
          nullable: true
    filters:
      type: object
      required:
      - id
      - pattern
      - enabled
      properties:
        enabled:
          $ref: '#/components/schemas/filters_components-schemas-enabled'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        pattern:
          $ref: '#/components/schemas/schemas-pattern'
    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
    filters_components-schemas-enabled:
      type: boolean
      title: Whether or not this filter will run a script
      example: true
    filters_components-schemas-id:
      type: string
      description: The unique identifier of the filter.
      example: 372e67954025e0ba6aaa6d586b9e0b61
      readOnly: true
      minLength: 32
      maxLength: 32
    filters_components-schemas-paused:
      type: boolean
      description: When true, indicates that the filter is currently paused.
      example: false
    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
    fips-settings:
      type: object
      description: FIPS settings.
      properties:
        tls:
          type: boolean
          description: Enable only cipher suites and TLS versions compliant with FIPS
            140-2.
          example: true
    firewall-rules_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
    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
    firewall-rules_components-schemas-id:
      type: string
      description: The unique identifier of the firewall rule.
      example: 372e67954025e0ba6aaa6d586b9e0b60
      readOnly: true
      maxLength: 32
    firewall-rules_components-schemas-paused:
      type: boolean
      description: When true, indicates that the firewall rule is currently paused.
      example: false
    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: 2.147483647e+09
    firewalluablock:
      properties:
        configuration:
          $ref: '#/components/schemas/components-schemas-configuration'
        description:
          $ref: '#/components/schemas/ua-rules_components-schemas-description'
        id:
          $ref: '#/components/schemas/ua-rules_components-schemas-id'
        mode:
          $ref: '#/components/schemas/ua-rules_components-schemas-mode'
        paused:
          $ref: '#/components/schemas/components-schemas-paused'
    firewalluablock_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/ua-rules'
    firewalluablock_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    first_name:
      type: string
      description: User's first name
      example: John
      nullable: true
      maxLength: 60
    fit:
      type: string
      description: The fit property describes how the width and height dimensions
        should be interpreted.
      enum:
      - scale-down
      - contain
      - cover
      - crop
      - pad
      example: scale-down
    flag:
      type: boolean
      description: The log retention flag for Logpull API.
      example: true
    flag_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              flag:
                type: boolean
                example: true
    follow_redirects:
      type: boolean
      description: Follow redirects if returned by the origin. This parameter is only
        valid for HTTP and HTTPS monitors.
      default: false
      example: true
    force_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/force_result'
    force_result:
      type: string
      description: When force_axfr query parameter is set to true, the response is
        a simple string
      example: OK
    frequency:
      type: string
      description: How often the subscription is renewed automatically.
      enum:
      - weekly
      - monthly
      - quarterly
      - yearly
      example: monthly
    full_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            allOf:
            - $ref: '#/components/schemas/address-maps'
            - type: object
              properties:
                ips:
                  $ref: '#/components/schemas/schemas-ips'
                memberships:
                  $ref: '#/components/schemas/memberships'
    gateway-account-device-settings:
      type: object
      properties:
        gateway_proxy_enabled:
          type: boolean
          description: Enable gateway proxy filtering on TCP.
          example: true
        gateway_udp_proxy_enabled:
          type: boolean
          description: Enable gateway proxy filtering on UDP.
          example: true
    gateway-account-device-settings-response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/gateway-account-device-settings'
      type: object
    gateway-account-logging-settings:
      type: object
      properties:
        redact_pii:
          type: boolean
          description: 'Redact personally identifiable information from activity logging
            (PII fields are: source IP, user email, user ID, device ID, URL, referrer,
            user agent).'
          example: true
        settings_by_rule_type:
          type: object
          description: Logging settings by rule type.
          properties:
            dns:
              type: object
              description: Logging settings for DNS firewall.
            http:
              type: object
              description: Logging settings for HTTP/HTTPS firewall.
            l4:
              type: object
              description: Logging settings for Network firewall.
    gateway-account-logging-settings-response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/gateway-account-logging-settings'
      type: object
    gateway-account-settings:
      type: object
      description: account settings.
      properties:
        settings:
          type: object
          description: account settings.
          properties:
            activity_log:
              $ref: '#/components/schemas/activity-log-settings'
            antivirus:
              $ref: '#/components/schemas/anti-virus-settings'
            block_page:
              $ref: '#/components/schemas/block-page-settings'
            browser_isolation:
              $ref: '#/components/schemas/browser-isolation-settings'
            fips:
              $ref: '#/components/schemas/fips-settings'
            tls_decrypt:
              $ref: '#/components/schemas/tls-settings'
    gateway_account:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              gateway_tag:
                $ref: '#/components/schemas/gateway_tag'
              id:
                $ref: '#/components/schemas/cf_account_id'
              provider_name:
                $ref: '#/components/schemas/provider_name'
      type: object
    gateway_account_config:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            allOf:
            - $ref: '#/components/schemas/gateway-account-settings'
            - properties:
                created_at:
                  $ref: '#/components/schemas/timestamp'
                updated_at:
                  $ref: '#/components/schemas/timestamp'
            type: object
      type: object
    gateway_seat:
      type: boolean
      description: True if the seat is part of Gateway.
      example: false
    gateway_tag:
      type: string
      description: Gateway internal id.
      example: f174e90afafe4643bbbc4a0ed4fc8415
      maxLength: 32
    gateway_unique_id:
      type: string
      example: 699d98642c564d2e855e9661899b7252
    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
    get-zone-connection-response:
      allOf:
      - $ref: '#/components/schemas/connection'
    get-zone-script-response:
      allOf:
      - $ref: '#/components/schemas/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/components-schemas-version'
    get-zone-settings-response:
      properties:
        enabled:
          $ref: '#/components/schemas/script-monitor_components-schemas-enabled'
        updated_at:
          $ref: '#/components/schemas/schemas-updated_at'
        use_cloudflare_reporting_endpoint:
          $ref: '#/components/schemas/use_cloudflare_reporting_endpoint'
        use_connection_url_path:
          $ref: '#/components/schemas/use_connection_url_path'
    get_ownership_response:
      allOf:
      - $ref: '#/components/schemas/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
    get_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - $ref: '#/components/schemas/zone_metadata'
    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
    grants:
      type: object
      example:
        read: true
        write: false
      properties:
        read:
          type: boolean
          example: true
        write:
          type: boolean
          example: true
    gre:
      type: object
      description: The configuration specific to GRE interconnects.
      properties:
        cloudflare_endpoint:
          type: string
          description: The IP address assigned to the Cloudflare side of the GRE tunnel
            created as part of the Interconnect.
          example: 203.0.113.1
        customer_endpoint:
          type: string
          description: The IP address assigned to the customer side of the GRE tunnel
            created as part of the Interconnect.
          example: 203.0.113.1
    gre-tunnel:
      type: object
      required:
      - name
      - customer_gre_endpoint
      - cloudflare_gre_endpoint
      - interface_address
      properties:
        cloudflare_gre_endpoint:
          $ref: '#/components/schemas/cloudflare_gre_endpoint'
        created_on:
          $ref: '#/components/schemas/common_components-schemas-created_on'
        customer_gre_endpoint:
          $ref: '#/components/schemas/customer_gre_endpoint'
        description:
          $ref: '#/components/schemas/gre-tunnel_components-schemas-description'
        health_check:
          $ref: '#/components/schemas/health_check'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier-2'
        interface_address:
          $ref: '#/components/schemas/interface_address'
        modified_on:
          $ref: '#/components/schemas/common_components-schemas-modified_on'
        mtu:
          $ref: '#/components/schemas/mtu'
        name:
          $ref: '#/components/schemas/gre-tunnel_components-schemas-name'
        ttl:
          $ref: '#/components/schemas/components-schemas-ttl'
    gre-tunnel_components-schemas-description:
      type: string
      description: An optional description of the GRE tunnel.
      example: Tunnel for ISP X
    gre-tunnel_components-schemas-name:
      type: string
      description: The name of the tunnel. The name cannot contain spaces or special
        characters, must be 15 characters or less, and cannot share a name with another
        GRE tunnel.
      example: GRE_1
    group:
      type: object
      properties:
        description:
          $ref: '#/components/schemas/group_components-schemas-description'
        id:
          $ref: '#/components/schemas/group_components-schemas-identifier'
        modified_rules_count:
          $ref: '#/components/schemas/modified_rules_count'
        name:
          $ref: '#/components/schemas/group_components-schemas-name'
        package_id:
          $ref: '#/components/schemas/package_components-schemas-identifier'
        rules_count:
          $ref: '#/components/schemas/rules_count'
    group_components-schemas-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
    group_components-schemas-identifier:
      type: string
      description: The unique identifier of the rule group.
      example: de677e5818985db1285d0e80225f06e5
      readOnly: true
      maxLength: 32
    group_components-schemas-name:
      type: string
      description: The name of the rule group.
      example: Project Honey Pot
      readOnly: true
    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
    groups_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/schemas-uuid'
    groups_components-schemas-name:
      type: string
      description: The name of the Access group.
      example: Allow devs
    groups_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/schemas-groups'
    groups_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/schemas-groups'
    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
    h2_prioritization:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - h2_prioritization
            example: h2_prioritization
          value:
            $ref: '#/components/schemas/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.
    h2_prioritization_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      - custom
      default: "off"
    hash:
      type: string
      description: The computed hash of the analyzed script.
      nullable: true
      minLength: 64
      maxLength: 64
    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.
        This parameter is only valid for HTTP and HTTPS monitors.
      example:
        Host:
        - example.com
        X-App-ID:
        - abc123
    header_name:
      type: string
      description: The name of the response header to match.
      example: Cf-Cache-Status
    header_op:
      type: string
      description: 'The operator used when matching: `eq` means "equal" and `ne` means
        "not equal".'
      enum:
      - eq
      - ne
      example: ne
    header_value:
      type: string
      description: The value of the response header, which must match exactly.
      example: HIT
    health_check:
      type: object
      properties:
        enabled:
          type: boolean
          description: Determines whether to run healthchecks for a tunnel.
          default: true
          example: true
        target:
          type: string
          description: The address used to run healthchecks for a tunnel. This field
            defaults to `customer_gre_endpoint address`.
          example: 203.0.113.1
        type:
          type: string
          description: The type of healthcheck to run, reply or request. The default
            value is `reply`.
          enum:
          - reply
          - request
          default: reply
          example: request
    health_details:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            description: A list of regions from which to run health checks. Null means
              every Cloudflare data center.
            example:
              pool_id: 17b5962d775c646f3f9725cbc7a53df4
              pop_health:
                Amsterdam, NL:
                  healthy: true
                  origins:
                  - 2001:DB8::5:
                      failure_reason: No failures
                      healthy: true
                      response_code: 401
                      rtt: 12.1ms
    healthchecks:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/schemas-address'
        check_regions:
          $ref: '#/components/schemas/schemas-check_regions'
        consecutive_fails:
          $ref: '#/components/schemas/consecutive_fails'
        consecutive_successes:
          $ref: '#/components/schemas/consecutive_successes'
        created_on:
          $ref: '#/components/schemas/timestamp'
        description:
          $ref: '#/components/schemas/healthchecks_components-schemas-description'
        failure_reason:
          $ref: '#/components/schemas/failure_reason'
        http_config:
          $ref: '#/components/schemas/http_config'
        id:
          $ref: '#/components/schemas/healthchecks_components-schemas-identifier'
        interval:
          $ref: '#/components/schemas/components-schemas-interval'
        modified_on:
          $ref: '#/components/schemas/timestamp'
        name:
          $ref: '#/components/schemas/healthchecks_components-schemas-name'
        retries:
          $ref: '#/components/schemas/retries'
        status:
          $ref: '#/components/schemas/healthchecks_components-schemas-status'
        suspended:
          $ref: '#/components/schemas/suspended'
        tcp_config:
          $ref: '#/components/schemas/tcp_config'
        timeout:
          $ref: '#/components/schemas/schemas-timeout'
        type:
          $ref: '#/components/schemas/healthchecks_components-schemas-type'
    healthchecks_components-schemas-description:
      type: string
      description: A human-readable description of the health check.
      example: Health check for www.example.com
    healthchecks_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/healthchecks_components-schemas-identifier'
    healthchecks_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    healthchecks_components-schemas-name:
      type: string
      description: A short name to identify the health check. Only alphanumeric characters,
        hyphens and underscores are allowed.
      example: server-1
    healthchecks_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/healthchecks'
    healthchecks_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/healthchecks'
    healthchecks_components-schemas-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
    healthchecks_components-schemas-type:
      type: string
      description: The protocol to use for the health check. Currently supported protocols
        are 'HTTP', 'HTTPS' and 'TCP'.
      default: HTTP
      example: HTTPS
    height:
      type: integer
      description: The height of the image in pixels.
      readOnly: true
    hero_url:
      type: string
      format: uri
      description: URI to hero variant for an image.
      example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero
      readOnly: true
    history:
      type: object
      properties:
        alert_body:
          $ref: '#/components/schemas/alert_body'
        alert_type:
          $ref: '#/components/schemas/schemas-alert_type'
        description:
          $ref: '#/components/schemas/history_components-schemas-description'
        id:
          $ref: '#/components/schemas/uuid'
        mechanism:
          $ref: '#/components/schemas/mechanism'
        mechanism_type:
          $ref: '#/components/schemas/mechanism_type'
        name:
          $ref: '#/components/schemas/history_components-schemas-name'
        sent:
          $ref: '#/components/schemas/sent'
    history_components-schemas-description:
      type: string
      description: Description of the notification policy (if present).
      example: Universal Certificate validation status, issuance, renewal, and expiration
        notices
    history_components-schemas-name:
      type: string
      description: Name of the policy.
      example: SSL Notification Event Policy
    history_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            example:
            - alert_body: SSL certificate has expired
              alert_type: universal_ssl_event_type
              description: Universal Certificate validation status, issuance, renewal,
                and expiration notices.
              id: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
              mechanism: test@example.com
              mechanism_type: email
              name: SSL Notification Event Policy
              sent: "2021-10-08T17:52:17.571336Z"
            items:
              $ref: '#/components/schemas/history'
          result_info:
            type: object
            example:
              count: 1
              page: 1
              per_page: 20
    hop_result:
      type: object
      properties:
        nodes:
          type: array
          description: An array of node objects.
          items:
            $ref: '#/components/schemas/node_result'
        packets_lost:
          $ref: '#/components/schemas/packets_lost'
        packets_sent:
          $ref: '#/components/schemas/packets_sent'
        packets_ttl:
          $ref: '#/components/schemas/packets_ttl'
    host:
      type: string
      format: hostname
      description: RFC3986-compliant host.
      example: www.example.com
      maxLength: 255
    hostname:
      type: string
      description: The custom hostname that will point to your hostname via CNAME.
      example: app.example.com
      readOnly: true
      maxLength: 255
    hostname-authenticated-origin-pull:
      allOf:
      - $ref: '#/components/schemas/hostname_certid_object'
      type: object
      properties:
        cert_id:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier'
        certificate:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate'
        enabled:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled'
        hostname:
          $ref: '#/components/schemas/schemas-hostname'
        id:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier'
        private_key:
          $ref: '#/components/schemas/schemas-private_key'
    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-----
    hostname-authenticated-origin-pull_components-schemas-certificate_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/hostname-authenticated-origin-pull'
    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
    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
    hostname-authenticated-origin-pull_components-schemas-identifier:
      type: string
      description: Certificate identifier tag.
      example: 2458ce5a-0c35-4c7f-82c7-8e9487d3ff60
      readOnly: true
      maxLength: 36
    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
    hostname_aop_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/hostname-authenticated-origin-pull'
    hostname_aop_single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/hostname_certid_object'
    hostname_certid_input:
      type: object
      properties:
        cert_id:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier'
        enabled:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled'
        hostname:
          $ref: '#/components/schemas/schemas-hostname'
    hostname_certid_object:
      properties:
        cert_id:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier'
        cert_status:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status'
        cert_updated_at:
          $ref: '#/components/schemas/updated_at'
        cert_uploaded_on:
          $ref: '#/components/schemas/components-schemas-uploaded_on'
        certificate:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate'
        created_at:
          $ref: '#/components/schemas/schemas-created_at'
        enabled:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-enabled'
        expires_on:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on'
        hostname:
          $ref: '#/components/schemas/schemas-hostname'
        issuer:
          $ref: '#/components/schemas/issuer'
        serial_number:
          $ref: '#/components/schemas/serial_number'
        signature:
          $ref: '#/components/schemas/signature'
        status:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status'
        updated_at:
          $ref: '#/components/schemas/updated_at'
    hostnames:
      type: array
      description: Array of hostnames or wildcard names (e.g., *.example.com) bound
        to the certificate.
      example:
      - example.com
      - '*.example.com'
      items: {}
    hosts:
      type: array
      items:
        type: string
        description: The valid hosts for the certificates.
        example: example.com
        readOnly: true
        maxLength: 253
    hotlink_protection:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - hotlink_protection
            example: hotlink_protection
          value:
            $ref: '#/components/schemas/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).
    hotlink_protection_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    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
    http_only_cookie_attribute:
      type: boolean
      description: Enables the HttpOnly cookie attribute, which increases security
        against XSS attacks.
      default: true
      example: true
    http2:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - http2
            example: http2
          value:
            $ref: '#/components/schemas/http2_value'
      title: HTTP2 Value
      description: HTTP2 enabled for this zone.
    http2_value:
      type: string
      description: Value of the HTTP2 setting.
      enum:
      - "on"
      - "off"
      default: "off"
    http3:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - http3
            example: http3
          value:
            $ref: '#/components/schemas/http3_value'
      title: HTTP3 Value
      description: HTTP3 enabled for this zone.
    http3_value:
      type: string
      description: Value of the HTTP3 setting.
      enum:
      - "on"
      - "off"
      default: "off"
    id:
      type: integer
      description: Unique id of the job.
      minimum: 1
    id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier'
    identifier:
      type: string
      description: Identifier
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    identity:
      type: string
      description: The wirefilter expression to be used for identity matching.
      example: any(identity.groups.name[*] in {"finance"})
    identity-providers:
      type: object
      properties:
        config:
          $ref: '#/components/schemas/schemas-config'
        id:
          $ref: '#/components/schemas/uuid'
        name:
          $ref: '#/components/schemas/identity-providers_components-schemas-name'
        type:
          $ref: '#/components/schemas/identity-providers_components-schemas-type'
    identity-providers_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    identity-providers_components-schemas-name:
      type: string
      description: The name of the identity provider, shown to users on the login
        page.
      example: Widget Corps OTP
    identity-providers_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/identity-providers'
    identity-providers_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/identity-providers'
    identity-providers_components-schemas-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/).
      example: onetimepin
    image_basic_upload_via_url:
      type: object
      required:
      - url
      properties:
        metadata:
          type: object
          description: User modifiable key-value store. Can use used for keeping references
            to another system of record for managing images.
        requireSignedURLs:
          type: boolean
          description: Indicates whether the image requires a signature token for
            the access.
          default: false
          example: true
        url:
          type: string
          description: A URL to fetch an image from origin.
          example: https://example.com/path/to/logo.png
    image_patch_request:
      type: object
      properties:
        metadata:
          type: object
          description: User modifiable key-value store. Can be used for keeping references
            to another system of record for managing images. No change if not specified.
        requireSignedURLs:
          type: boolean
          description: Indicates whether the image can be accessed using only its
            UID. If set to `true`, a signed token needs to be generated with a signing
            key to view the image. Returns a new UID on a change. No change if not
            specified.
          example: true
    image_resizing:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - image_resizing
            example: image_resizing
          value:
            $ref: '#/components/schemas/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.
    image_resizing_value:
      type: string
      description: Whether the feature is enabled, disabled, or enabled in `open proxy`
        mode.
      enum:
      - "on"
      - "off"
      - open
      default: "off"
    image_response_blob:
      anyOf:
      - type: string
      - type: object
      example: <image blob data>
    image_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/images'
    image_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    images:
      type: object
      properties:
        filename:
          $ref: '#/components/schemas/filename'
        id:
          $ref: '#/components/schemas/images_components-schemas-identifier'
        metadata:
          $ref: '#/components/schemas/metadata'
        requireSignedURLs:
          $ref: '#/components/schemas/schemas-requireSignedURLs'
        uploaded:
          $ref: '#/components/schemas/schemas-uploaded'
        variants:
          $ref: '#/components/schemas/schemas-variants'
    images_components-schemas-account_identifier:
      type: string
      description: Account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    images_components-schemas-identifier:
      type: string
      description: Image unique identifier.
      example: 107b9558-dd06-4bbd-5fef-9c2c16bb7900
      readOnly: true
      maxLength: 32
    images_count:
      type: object
      properties:
        allowed:
          $ref: '#/components/schemas/allowed'
        current:
          $ref: '#/components/schemas/current'
    images_stats:
      type: object
      properties:
        count:
          $ref: '#/components/schemas/images_count'
    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/rule_components-schemas-rule'
    input:
      type: object
      readOnly: true
      properties:
        height:
          type: integer
          description: The video height in pixels. A value of `-1` means the height
            is unknown. The value becomes available after the upload and before the
            video is ready.
          readOnly: true
        width:
          type: integer
          description: The video width in pixels. A value of `-1` means the width
            is unknown. The value becomes available after the upload and before the
            video is ready.
          readOnly: true
    install_id:
      type: string
      description: app install id.
    interconnect:
      type: object
      properties:
        colo_name:
          $ref: '#/components/schemas/interconnect_components-schemas-name'
        created_on:
          $ref: '#/components/schemas/common_components-schemas-created_on'
        description:
          $ref: '#/components/schemas/interconnect_components-schemas-description'
        gre:
          $ref: '#/components/schemas/gre'
        health_check:
          $ref: '#/components/schemas/schemas-health_check'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier-2'
        interface_address:
          $ref: '#/components/schemas/interface_address'
        modified_on:
          $ref: '#/components/schemas/common_components-schemas-modified_on'
        mtu:
          $ref: '#/components/schemas/schemas-mtu'
        name:
          $ref: '#/components/schemas/interconnect_components-schemas-name'
    interconnect_components-schemas-description:
      type: string
      description: An optional description of the interconnect.
      example: Tunnel for Interconnect to ORD
    interconnect_components-schemas-name:
      type: string
      description: The name of the interconnect. The name cannot share a name with
        other tunnels.
      example: pni_ord
    interface_address:
      type: string
      description: 'A 31-bit prefix (/31 in CIDR notation) supporting two hosts, one
        for each side of the tunnel. Select the subnet from the following private
        IP space: 10.0.0.0–10.255.255.255, 172.16.0.0–172.31.255.255, 192.168.0.0–192.168.255.255.'
      example: 192.0.2.0/31
    interval:
      type: integer
      description: The interval between each health check. Shorter intervals may improve
        failover time, but will increase load on the origins as we check from multiple
        locations.
      default: 60
    intune_config_request:
      type: object
      required:
      - customer_id
      - client_id
      - client_secret
      properties:
        client_id:
          type: string
          description: The Intune client ID.
          example: example client id
        client_secret:
          type: string
          description: The Intune client secret.
          example: example client secret
        customer_id:
          type: string
          description: The Intune customer ID.
          example: example customer id
    invite:
      allOf:
      - $ref: '#/components/schemas/organization_invite'
      type: object
    invite_components-schemas-identifier:
      type: string
      description: Invite identifier tag.
      example: 4f5f0c14a2a41d5063dd301b2f829f04
      readOnly: true
      maxLength: 32
    invited_by:
      type: string
      description: The email address of the user who created the invite.
      example: user@example.com
      maxLength: 90
    invited_member_email:
      type: string
      description: Email address of the user to add to the organization.
      example: user@example.com
      maxLength: 90
    invited_on:
      type: string
      format: date-time
      description: When the invite was sent.
      example: "2014-01-01T05:20:00Z"
      readOnly: true
    ip:
      type: string
      description: IPv4/IPv6 address of primary or secondary nameserver, depending
        on what zone this peer is linked to. For primary zones this IP defines the
        IP of the secondary nameserver Cloudflare will NOTIFY upon zone changes. For
        secondary zones this IP defines the IP of the primary nameserver Cloudflare
        will send AXFR/IXFR requests to.
      example: 192.0.2.53
    ip-list:
      properties:
        description:
          type: string
        id:
          type: integer
        name:
          type: string
          example: Malware
    ip_address:
      type: string
      description: An IPv4 or IPv6 address.
      example: 192.0.2.1
    ip_components-schemas-ip:
      properties:
        belongs_to_ref:
          type: object
          description: Specifies a reference to the autonomous systems (AS) that the
            IP address belongs to.
          properties:
            country:
              type: string
              example: US
            description:
              type: string
              example: CLOUDFLARENET
            id:
              example: autonomous-system--2fa28d71-3549-5a38-af05-770b79ad6ea8
            type:
              type: string
              description: Infrastructure type of this ASN.
              enum:
              - hosting_provider
              - isp
              - organization
              example: hosting_provider
            value:
              type: string
        ip:
          $ref: '#/components/schemas/common_components-schemas-ip'
        risk_types:
          example:
          - id: 131
            name: Phishing
            super_category_id: 21
    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
    ip_firewall:
      type: boolean
      description: |-
        Enables IP Access Rules for this application.
        Notes: Only available for TCP applications.
      example: true
    ip_geolocation:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - ip_geolocation
            example: ip_geolocation
          value:
            $ref: '#/components/schemas/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).
    ip_geolocation_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "on"
    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
    ip_network:
      type: string
      description: The private IPv4 or IPv6 range connected by the route, in CIDR
        notation.
      example: 172.16.0.0/16
    ip_network_encoded:
      type: string
      description: IP/CIDR range in URL-encoded format
      example: 172.16.0.0%2F16
    ip_range:
      type: string
      description: Allowed IPv4/IPv6 address range of primary or secondary nameservers.
        This will be applied for the entire account. The IP range is used to allow
        additional NOTIFY IPs for secondary zones and IPs Cloudflare allows AXFR/IXFR
        requests from for primary zones. CIDRs are limited to a maximum of /24 for
        IPv4 and /64 for IPv6 respectively.
      example: 192.0.2.53/28
    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
    ipam-delegations:
      type: object
      properties:
        cidr:
          $ref: '#/components/schemas/cidr'
        created_at:
          $ref: '#/components/schemas/timestamp'
        delegated_account_id:
          $ref: '#/components/schemas/delegated_account_identifier'
        id:
          $ref: '#/components/schemas/delegation_identifier'
        modified_at:
          $ref: '#/components/schemas/timestamp'
        parent_prefix_id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
    ipam-delegations_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/delegation_identifier'
    ipam-delegations_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/ipam-delegations'
    ipam-delegations_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/ipam-delegations'
    ipam-prefixes:
      type: object
      properties:
        account_id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        advertised:
          $ref: '#/components/schemas/advertised'
        advertised_modified_at:
          $ref: '#/components/schemas/modified_at_nullable'
        approved:
          $ref: '#/components/schemas/approved'
        asn:
          $ref: '#/components/schemas/asn'
        cidr:
          $ref: '#/components/schemas/cidr'
        created_at:
          $ref: '#/components/schemas/timestamp'
        description:
          $ref: '#/components/schemas/ipam-prefixes_components-schemas-description'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        loa_document_id:
          $ref: '#/components/schemas/loa_document_identifier'
        modified_at:
          $ref: '#/components/schemas/timestamp'
        on_demand_enabled:
          $ref: '#/components/schemas/on_demand_enabled'
        on_demand_locked:
          $ref: '#/components/schemas/on_demand_locked'
    ipam-prefixes_components-schemas-description:
      type: string
      description: Description of the prefix.
      example: Internal test prefix
      maxLength: 1000
    ipam-prefixes_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/ipam-prefixes'
    ipam-prefixes_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/ipam-prefixes'
    ips:
      type: object
      properties:
        etag:
          type: string
          description: A digest of the IP data. Useful for determining if the data
            has changed.
          example: a8e453d9d129a3769407127936edfdb0
        ipv4_cidrs:
          type: array
          description: List of Cloudflare IPv4 CIDR addresses.
          items:
            type: string
            description: IPv4 CIDR.
            example: 199.27.128.0/21
        ipv6_cidrs:
          type: array
          description: List of Cloudflare IPv6 CIDR addresses.
          items:
            type: string
            description: IPv6 CIDR.
            example: 2400:cb00::/32
    ipsec-tunnel:
      type: object
      required:
      - name
      - cloudflare_endpoint
      - interface_address
      properties:
        allow_null_cipher:
          $ref: '#/components/schemas/allow_null_cipher'
        cloudflare_endpoint:
          $ref: '#/components/schemas/cloudflare_ipsec_endpoint'
        created_on:
          $ref: '#/components/schemas/common_components-schemas-created_on'
        customer_endpoint:
          $ref: '#/components/schemas/customer_ipsec_endpoint'
        description:
          $ref: '#/components/schemas/ipsec-tunnel_components-schemas-description'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier-2'
        interface_address:
          $ref: '#/components/schemas/interface_address'
        modified_on:
          $ref: '#/components/schemas/common_components-schemas-modified_on'
        name:
          $ref: '#/components/schemas/ipsec-tunnel_components-schemas-name'
        psk_metadata:
          $ref: '#/components/schemas/psk_metadata'
        tunnel_health_check:
          $ref: '#/components/schemas/tunnel_health_check'
    ipsec-tunnel_components-schemas-description:
      type: string
      description: An optional description forthe IPsec tunnel.
      example: Tunnel for ISP X
    ipsec-tunnel_components-schemas-name:
      type: string
      description: The name of the IPsec tunnel. The name cannot share a name with
        other tunnels.
      example: IPsec_1
    ipv4:
      type: string
      format: ipv4
      example: 192.0.2.0
    ipv6:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - ipv6
            example: ipv6
          value:
            $ref: '#/components/schemas/ipv6_value'
      title: IPv6
      description: Enable IPv6 on all subdomains that are Cloudflare enabled.  (https://support.cloudflare.com/hc/en-us/articles/200168586).
    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
    ipv6_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "off"
      - "on"
      default: "off"
    is_default_network:
      type: boolean
      description: If `true`, this virtual network is the default for the account.
      example: true
    is_pending_reconnect:
      type: boolean
      description: Cloudflare continues to track connections for several minutes after
        they disconnect. This is an optimization to improve latency and reliability
        of reconnecting.  If `true`, the connection has disconnected but is still
        being tracked. If `false`, the connection is actively serving traffic.
      example: false
    is_subscribed:
      type: boolean
      description: Indicates whether you are currently subscribed to this plan.
      default: false
      example: false
    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"
    issued_on:
      type: string
      format: date-time
      description: The time on which the token was created.
      example: "2018-07-01T05:20:00Z"
      readOnly: true
    issuer:
      type: string
      description: The certificate authority that issued the certificate.
      example: GlobalSign
      readOnly: true
    item:
      oneOf:
      - required:
        - ip
      - required:
        - redirect
      type: object
      example:
        comment: Private IP address
        created_on: "2020-01-01T08:00:00Z"
        id: 2c0fc9fa937b11eaa1b71c4d701ab86e
        ip: 10.0.0.1
        modified_on: "2020-01-10T14:00:00Z"
      properties:
        comment:
          $ref: '#/components/schemas/item_comment'
        created_on:
          type: string
          description: The RFC 3339 timestamp of when the item was created.
          example: "2020-01-01T08:00:00Z"
          readOnly: true
        id:
          $ref: '#/components/schemas/list_id'
        ip:
          $ref: '#/components/schemas/item_ip'
        modified_on:
          type: string
          description: The RFC 3339 timestamp of when the item was last modified.
          example: "2020-01-10T14:00:00Z"
          readOnly: true
        redirect:
          $ref: '#/components/schemas/item_redirect'
    item-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            $ref: '#/components/schemas/item'
    item_comment:
      type: string
      description: An informative summary of the list item.
      example: Private IP address
    item_id:
      type: string
      description: The unique ID of the item in the List.
      example: 34b12448945f11eaa1b71c4d701ab86e
    item_ip:
      type: string
      description: An IPv4 address, an IPv4 CIDR, or an IPv6 CIDR. IPv6 CIDRs are
        limited to a maximum of /64.
      example: 10.0.0.1
    item_redirect:
      type: object
      description: The definition of the redirect.
      required:
      - source_url
      - target_url
      properties:
        include_subdomains:
          type: boolean
          default: false
        preserve_path_suffix:
          type: boolean
          default: true
        preserve_query_string:
          type: boolean
          default: false
        source_url:
          type: string
          example: example.com/arch
        status_code:
          type: integer
          enum:
          - 301
          - 302
          - 307
          - 308
          default: 301
        subpath_matching:
          type: boolean
          default: false
        target_url:
          type: string
          example: https://archlinux.org/
    items:
      type: array
      items:
        $ref: '#/components/schemas/item'
    items-list-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            $ref: '#/components/schemas/items'
          result_info:
            type: object
            properties:
              cursors:
                type: object
                properties:
                  after:
                    type: string
                    example: yyy
                  before:
                    type: string
                    example: xxx
    items-update-request-collection:
      type: array
      items:
        allOf:
        - oneOf:
          - required:
            - ip
          - required:
            - redirect
          type: object
          properties:
            comment:
              $ref: '#/components/schemas/item_comment'
            ip:
              $ref: '#/components/schemas/item_ip'
            redirect:
              $ref: '#/components/schemas/item_redirect'
    ixfr_enable:
      type: boolean
      description: Enable IXFR transfer protocol, default is AXFR. Only applicable
        to secondary zones.
      example: false
    js_integrity_score:
      type: integer
      description: The integrity score of the JavaScript content.
      nullable: true
      minimum: 1
      maximum: 99
    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
    jwk:
      type: string
      description: The signing key in JWK format.
      example: eyJ1c2UiOiJzaWciLCJrdHkiOiJSU0EiLCJraWQiOiI1MjEzY2ZhMTIxZjcwYjhjMTM4MDY4NmZmYzM3MWJhMyIsImFsZyI6IlJTMjU2IiwibiI6IjBUandqT2laV21KNDN2ZjNUbzREb1htWFd0SkdOR3lYZmh5dHRMYUJnRjEtRVFXUURLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMtbFlSWW95ckFHRjRBWGh5MzI5YkhDUDFJbHJCQl9Ba0dnbmRMQWd1bnhZMHJSZ2N2T3ppYXc2S0p4Rm5jMlVLMFdVOGIwcDRLS0hHcDFLTDlkazBXVDhkVllxYmVSaUpqQ2xVRW1oOHl2OUNsT1ZhUzRLeGlYNnhUUTREWnc2RGFKZklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWi1peFdmY1RETUg5MnNHdm93MURPanhMaUNOMXpISy1oN2JMb1hUaUxnYzRrdyIsImUiOiJBUUFCIiwiZCI6IndpQWEwaU5mWnNYSGNOcVMxSWhnUmdzVHJHay1TcFlYV2lReDZHTU9kWlJKekhGazN0bkRERFJvNHNKZTBxX0dEOWkzNlEyZkVadS15elpEcEJkc3U5OHNtaHhNU19Ta0s5X3VFYUo1Zm96V2IyN3JRRnFoLVliUU9MUThkUnNPRHZmQl9Hb2txWWJzblJDR3kzWkFaOGZJZ25ocXBUNEpiOHdsaWxpMUgxeFpzM3RnTWtkTEluTm1yMFAtcTYxZEtNd3JYZVRoSWNEc0kyb2Z1LTFtRm1MWndQb2ZGbmxaTW9QN1pfRU5pUGNfWGtWNzFhaHBOZE9pcW5ablZtMHBCNE5QS1UweDRWTjQyYlAzWEhMUmpkV2hJOGt3SC1BdXhqb3BLaHJ0R2tvcG1jZFRkM1ZRdElaOGRpZHByMXpBaEpvQi16ZVlIaTFUel9ZSFFld0FRUSIsInAiOiIyVTZFVUJka3U3TndDYXoyNzZuWGMxRXgwVHpNZjU4U0UtU2M2eUNaYWk2TkwzVURpWi1mNHlIdkRLYnFGUXdLWDNwZ0l2aVE3Y05QYUpkbE9NeS1mU21GTXU3V3hlbVZYamFlTjJCMkRDazhQY0NEOVgxU2hhR3E1ZUdSSHNObVUtSDNxTG1FRGpjLWliazRHZ0RNb2lVYjQ2OGxFZHAwU2pIOXdsOUdsYTgiLCJxIjoiOW5ucXg5ZnNNY2dIZ29DemhfVjJmaDhoRUxUSUM5aFlIOVBCTG9aQjZIaE1TWG1ja1BSazVnUlpPWlFEN002TzlMaWZjNmFDVXdEbjBlQzU2YkFDNUNrcWxjODJsVDhzTWlMeWJyTjh3bWotcjNjSTBGQTlfSGQySEY1ZkgycnJmenVqd0NWM3czb09Ud3p4d1g3c2xKbklRanphel91SzEyWEtucVZZcUYwIiwiZHAiOiJxQklTUTlfVUNWaV9Ucng0UU9VYnZoVU9jc2FUWkNHajJiNzNudU9YeElnOHFuZldSSnN4RG5zd2FKaXdjNWJjYnZ3M1h0VGhRd1BNWnhpeE1UMHFGNlFGWVY5WXZibnJ6UEp4YkdNdTZqajZYc2lIUjFlbWU3U09lVDM4Xzg0aFZyOXV6UkN2RWstb0R0MHlodW9YVzFGWVFNRTE2cGtMV0ZkUjdRUERsQUUiLCJkcSI6Im5zQUp3eXZFbW8tdW5wU01qYjVBMHB6MExCRjBZNFMxeGRJYXNfLVBSYzd0dThsVFdWMl8teExEOFR6dmhqX0lmY0RJR3JJZGNKNjlzVVZnR1M3ZnZkcng3Y21uNjFyai1XcmU0UVJFRC1lV1dxZDlpc2FVRmg5UGVKZ2tCbFZVVnYtdnladVlWdFF2a1NUU05ZR3RtVXl2V2xKZDBPWEFHRm9jdGlfak9aVSIsInFpIjoib0dYaWxLQ2NKRXNFdEE1eG54WUdGQW5UUjNwdkZLUXR5S0F0UGhHaHkybm5ya2VzN1RRaEFxMGhLRWZtU1RzaE1hNFhfd05aMEstX1F0dkdoNDhpeHdTTDVLTEwxZnFsY0k2TF9XUnF0cFQxS21LRERlUHR2bDVCUzFGbjgwSGFwR215cmZRWUU4S09QR2UwUl82S1BOZE1vc3dYQ3Nfd0RYMF92ZzNoNUxRIn0=
      readOnly: true
    key:
      type: object
      description: A name for a value. A value stored under a given key may be retrieved
        via the same key.
      required:
      - name
      properties:
        expiration:
          type: number
          description: The time, measured in number of seconds since the UNIX epoch,
            at which the key will expire. This property is omitted for keys that will
            not expire.
          example: 1.5778368e+09
        metadata:
          $ref: '#/components/schemas/list_metadata'
        name:
          $ref: '#/components/schemas/key_name'
    key_config:
      type: object
      properties:
        days_until_next_rotation:
          $ref: '#/components/schemas/days_until_next_rotation'
        key_rotation_interval_days:
          $ref: '#/components/schemas/key_rotation_interval_days'
        last_key_rotation_at:
          $ref: '#/components/schemas/last_key_rotation_at'
    key_generation_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            $ref: '#/components/schemas/keys'
    key_name:
      type: string
      description: A key's name. The name may be at most 512 bytes. All printable,
        non-whitespace characters are valid. Use percent-encoding to define key names
        as part of a URL.
      example: My-Key
      maxLength: 512
    key_name_bulk:
      type: string
      description: A key's name. The name may be at most 512 bytes. All printable,
        non-whitespace characters are valid.
      example: My-Key
      maxLength: 512
    key_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              type: object
              properties:
                created:
                  $ref: '#/components/schemas/keys_components-schemas-created'
                id:
                  $ref: '#/components/schemas/keys_components-schemas-identifier'
    key_rotation_interval_days:
      type: number
      description: The number of days between key rotations.
      example: 30
      minimum: 21
      maximum: 365
    keyless-certificate:
      allOf:
      - $ref: '#/components/schemas/keyless-certificate_components-schemas-base'
      type: object
    keyless-certificate_components-schemas-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/schemas-enabled'
        host:
          $ref: '#/components/schemas/schemas-host'
        id:
          $ref: '#/components/schemas/keyless-certificate_components-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/keyless-certificate_components-schemas-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/schemas-port'
        status:
          $ref: '#/components/schemas/keyless-certificate_components-schemas-status'
    keyless-certificate_components-schemas-identifier:
      type: string
      description: Keyless certificate identifier tag.
      example: 4d2844d2ce78891c34d0b6c0535a291e
      readOnly: true
      maxLength: 32
    keyless-certificate_components-schemas-name:
      type: string
      description: The keyless SSL name.
      example: example.com Keyless SSL
      readOnly: true
      maxLength: 180
    keyless-certificate_components-schemas-status:
      type: string
      description: Status of the Keyless SSL.
      enum:
      - active
      - deleted
      example: active
      readOnly: true
    keyless_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/keyless-certificate'
    keyless_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    keyless_response_single_id:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/keyless-certificate_components-schemas-identifier'
    keys:
      type: object
      properties:
        created:
          $ref: '#/components/schemas/keys_components-schemas-created'
        id:
          $ref: '#/components/schemas/keys_components-schemas-identifier'
        jwk:
          $ref: '#/components/schemas/jwk'
        pem:
          $ref: '#/components/schemas/pem'
    keys_components-schemas-created:
      type: string
      format: date-time
      description: The date and time a signing key was created.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    keys_components-schemas-identifier:
      example: 5213cfa121f70b8c1380686ffc371ba3
    keys_components-schemas-identifier-2:
      example: 699d98642c564d2e855e9661899b7252
    keys_components-schemas-name:
      type: string
      description: Key name.
      example: default
      readOnly: true
    keys_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - $ref: '#/components/schemas/key_config'
    keys_components-schemas-value:
      type: string
      description: Key value.
      example: Oix0bbNaT8Rge9PuyxUBrjI6zrgnsyJ5=
      readOnly: true
    keys_response:
      type: object
      properties:
        keys:
          type: array
          items:
            $ref: '#/components/schemas/schemas-keys'
    kind:
      type: string
      description: The type of the list. Each type supports specific list items (IP
        addresses or redirects).
      enum:
      - ip
      - redirect
      example: ip
    kv_components-schemas-value:
      type: string
      description: A byte sequence to be stored, up to 10 MB in length.
      example: Some Value
    kv_namespace_binding:
      type: object
      required:
      - name
      - type
      - namespace_id
      properties:
        name:
          $ref: '#/components/schemas/binding_name'
        namespace_id:
          $ref: '#/components/schemas/namespace_identifier'
        type:
          type: string
          description: The class of resource that the binding provides.
          enum:
          - kv_namespace
          example: kv_namespace
    label:
      type: string
      description: The language label displayed in the native language to users.
      example: Türkçe
      readOnly: true
    labels:
      type: array
      description: Field appears if there is an additional annotation printed when
        the probe returns. Field also appears when running a GRE+ICMP traceroute to
        denote which traceroute a node comes from.
      items:
        type: string
    language:
      type: string
      description: The language tag in BCP 47 format.
      example: tr
      readOnly: true
    language_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/captions'
    language_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    last_failure:
      type: string
      format: date-time
      description: Timestamp of the last time an attempt to dispatch a notification
        to this webhook failed.
      example: "2020-10-26T18:25:04.532316Z"
      readOnly: true
    last_key_rotation_at:
      type: string
      format: date-time
      description: The timestamp of the previous key rotation.
      example: "2014-01-01T05:20:00.12345Z"
    last_name:
      type: string
      description: User's last name
      example: Appleseed
      nullable: true
      maxLength: 60
    last_seen:
      type: string
      format: date-time
      description: When the device last connected to Cloudflare services.
      example: "2017-06-14T00:00:00Z"
    last_success:
      type: string
      format: date-time
      description: Timestamp of the last time Cloudflare was able to successfully
        dispatch a notification using this webhook.
      example: "2020-10-26T18:25:04.532316Z"
      readOnly: true
    last_successful_login:
      type: string
      format: date-time
      description: The time at which the user last successfully logged in.
      example: "2020-07-01T05:20:00Z"
    last_updated:
      type: string
      description: The timestamp of when the ruleset was last modified.
      example: "2000-01-01T00:00:00.000000Z"
    latitude:
      type: number
      description: The latitude of the data center containing the origins used in
        this pool in decimal degrees. If this is set, longitude must also be set.
    legacy_discount:
      type: boolean
      description: Indicates whether this plan has a legacy discount applied.
      default: false
      example: false
    legacy_id:
      type: string
      description: The legacy identifier for this rate plan, if any.
      example: free
      readOnly: true
    list:
      properties:
        created_on:
          $ref: '#/components/schemas/components-schemas-created_on'
        description:
          $ref: '#/components/schemas/lists_components-schemas-description'
        id:
          $ref: '#/components/schemas/list_id'
        kind:
          $ref: '#/components/schemas/kind'
        modified_on:
          $ref: '#/components/schemas/lists_components-schemas-modified_on'
        name:
          $ref: '#/components/schemas/lists_components-schemas-name'
        num_items:
          $ref: '#/components/schemas/num_items'
        num_referencing_filters:
          $ref: '#/components/schemas/num_referencing_filters'
    list-delete-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/item_id'
    list-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            $ref: '#/components/schemas/list'
    list-zone-connections-response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/connection'
          result_info:
            $ref: '#/components/schemas/result_info'
    list-zone-scripts-response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/script'
          result_info:
            $ref: '#/components/schemas/result_info'
    list_id:
      type: string
      description: The unique ID of the list.
      example: 2c0fc9fa937b11eaa1b71c4d701ab86e
      readOnly: true
      minLength: 32
      maxLength: 32
    list_item_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/schemas-items'
      - properties:
          result_info:
            type: object
            properties:
              count:
                type: number
                description: Total results returned based on your search parameters.
                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
    list_metadata:
      type: object
      description: Arbitrary JSON that is associated with a key.
      example:
        someMetadataKey: someMetadataValue
    lists:
      type: object
      properties:
        count:
          $ref: '#/components/schemas/count'
        created_at:
          $ref: '#/components/schemas/timestamp'
        description:
          $ref: '#/components/schemas/lists_components-schemas-description-2'
        id:
          $ref: '#/components/schemas/lists_components-schemas-uuid'
        name:
          $ref: '#/components/schemas/lists_components-schemas-name-2'
        type:
          $ref: '#/components/schemas/lists_components-schemas-type'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    lists-async-response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: object
            properties:
              operation_id:
                $ref: '#/components/schemas/schemas-operation_id'
    lists-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/list'
              - type: object
                required:
                - id
                - name
                - kind
                - num_items
                - created_on
                - modified_on
    lists_components-schemas-description:
      type: string
      description: An informative summary of the list.
      example: This is a note.
      maxLength: 500
    lists_components-schemas-description-2:
      type: string
      description: The description of the List.
      example: The serial numbers for administrators
    lists_components-schemas-empty_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    lists_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    lists_components-schemas-modified_on:
      type: string
      description: The RFC 3339 timestamp of when the list was last modified.
      example: "2020-01-10T14:00:00Z"
    lists_components-schemas-name:
      type: string
      description: An informative name for the list. Use this name in filter and rule
        expressions.
      example: list1
      maxLength: 50
      pattern: ^[a-zA-Z0-9_]+$
    lists_components-schemas-name-2:
      type: string
      description: The name of the List.
      example: Admin Serial Numbers
    lists_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/lists'
    lists_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/lists'
    lists_components-schemas-type:
      type: string
      description: The type of List.
      enum:
      - SERIAL
      - URL
      - DOMAIN
      - EMAIL
      - IP
      example: SERIAL
    lists_components-schemas-uuid:
      type: string
      description: API Resource UUID tag.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
    lists_components-schemas-value:
      type: string
      description: The value of the item in a List.
      example: 8GE8721REF
    live_input_default_creator:
      type: string
      description: Sets the creator ID asssociated with this live input.
    live_input_identifier:
      type: string
      description: A unique identifier for a live input.
      example: 66be4bf738797e01e1fca35a7bdecdcd
      readOnly: true
      maxLength: 32
    live_input_metadata:
      type: object
      description: A user modifiable key-value store used to reference other systems
        of record for managing live inputs.
      example:
        name: test stream 1
    live_input_object_without_url:
      properties:
        created:
          $ref: '#/components/schemas/connect_components-schemas-created'
        meta:
          $ref: '#/components/schemas/live_input_metadata'
        modified:
          $ref: '#/components/schemas/components-schemas-modified'
        uid:
          $ref: '#/components/schemas/live_input_identifier'
    live_input_recording_allowedOrigins:
      type: array
      description: Lists the origins allowed to display videos created with this input.
        Enter allowed origin domains in an array and use `*` for wildcard subdomains.
        An empty array allows videos to be viewed on any origin.
      example:
      - example.com
      items:
        type: string
    live_input_recording_mode:
      type: string
      description: Specifies the recording behavior for the live input. Set this value
        to `off` to prevent a recording. Set the value to `automatic` to begin a recording
        and transition to on-demand after Stream Live stops receiving input.
      enum:
      - "off"
      - automatic
      default: "off"
      example: automatic
    live_input_recording_requireSignedURLs:
      type: boolean
      description: Indicates if a video using the live input has the `requireSignedURLs`
        property set. Also enforces access controls on any video recording of the
        livestream with the live input.
      default: false
      example: true
    live_input_recording_settings:
      type: object
      description: Records the input to a Cloudflare Stream video. Behavior depends
        on the mode. In most cases, the video will initially be viewable as a live
        video and transition to on-demand after a condition is satisfied.
      example:
        mode: "off"
        requireSignedURLs: false
        timeoutSeconds: 0
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/live_input_recording_allowedOrigins'
        mode:
          $ref: '#/components/schemas/live_input_recording_mode'
        requireSignedURLs:
          $ref: '#/components/schemas/live_input_recording_requireSignedURLs'
        timeoutSeconds:
          $ref: '#/components/schemas/live_input_recording_timeoutSeconds'
    live_input_recording_timeoutSeconds:
      type: integer
      description: Determines the amount of time a live input configured in `automatic`
        mode should wait before a recording transitions from live to on-demand. `0`
        is recommended for most use cases and indicates the platform default should
        be used.
      default: 0
    live_input_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: object
            properties:
              liveInputs:
                type: array
                items:
                  $ref: '#/components/schemas/live_input_object_without_url'
              range:
                type: integer
                description: The total number of remaining live inputs based on cursor
                  position.
                example: 1000
                readOnly: true
              total:
                type: integer
                description: The total number of live inputs that match the provided
                  filters.
                example: 35586
                readOnly: true
    live_input_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    liveInput:
      type: string
      description: The live input ID used to upload a video with Stream Live.
      example: fc0a8dc887b16759bfd9ad922230a014
      readOnly: true
      maxLength: 32
    loa_document_identifier:
      type: string
      description: Identifier for the uploaded LOA document.
      example: d933b1530bc56c9953cf8ce166da8004
      nullable: true
      readOnly: true
      maxLength: 32
    loa_upload_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              filename:
                type: string
                description: Name of LOA document.
                example: document.pdf
    load-balancer:
      type: object
      properties:
        adaptive_routing:
          $ref: '#/components/schemas/adaptive_routing'
        country_pools:
          $ref: '#/components/schemas/country_pools'
        created_on:
          $ref: '#/components/schemas/timestamp'
        default_pools:
          $ref: '#/components/schemas/default_pools'
        description:
          $ref: '#/components/schemas/load-balancer_components-schemas-description'
        enabled:
          $ref: '#/components/schemas/load-balancer_components-schemas-enabled'
        fallback_pool:
          $ref: '#/components/schemas/fallback_pool'
        id:
          $ref: '#/components/schemas/load-balancer_components-schemas-identifier'
        location_strategy:
          $ref: '#/components/schemas/location_strategy'
        modified_on:
          $ref: '#/components/schemas/timestamp'
        name:
          $ref: '#/components/schemas/load-balancer_components-schemas-name'
        pop_pools:
          $ref: '#/components/schemas/pop_pools'
        proxied:
          $ref: '#/components/schemas/schemas-proxied'
        random_steering:
          $ref: '#/components/schemas/random_steering'
        region_pools:
          $ref: '#/components/schemas/region_pools'
        rules:
          $ref: '#/components/schemas/load-balancer_components-schemas-rules'
        session_affinity:
          $ref: '#/components/schemas/session_affinity'
        session_affinity_attributes:
          $ref: '#/components/schemas/session_affinity_attributes'
        session_affinity_ttl:
          $ref: '#/components/schemas/session_affinity_ttl'
        steering_policy:
          $ref: '#/components/schemas/steering_policy'
        ttl:
          $ref: '#/components/schemas/schemas-ttl'
    load-balancer_components-schemas-description:
      type: string
      description: Object description.
      example: Load Balancer for www.example.com
    load-balancer_components-schemas-enabled:
      type: boolean
      description: Whether to enable (the default) this load balancer.
      default: true
      example: true
    load-balancer_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/load-balancer_components-schemas-identifier'
    load-balancer_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    load-balancer_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
    load-balancer_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/load-balancer'
    load-balancer_components-schemas-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/adaptive_routing'
              country_pools:
                $ref: '#/components/schemas/country_pools'
              default_pools:
                $ref: '#/components/schemas/default_pools'
              fallback_pool:
                $ref: '#/components/schemas/fallback_pool'
              location_strategy:
                $ref: '#/components/schemas/location_strategy'
              pop_pools:
                $ref: '#/components/schemas/pop_pools'
              random_steering:
                $ref: '#/components/schemas/random_steering'
              region_pools:
                $ref: '#/components/schemas/region_pools'
              session_affinity:
                $ref: '#/components/schemas/session_affinity'
              session_affinity_attributes:
                $ref: '#/components/schemas/session_affinity_attributes'
              session_affinity_ttl:
                $ref: '#/components/schemas/session_affinity_ttl'
              steering_policy:
                $ref: '#/components/schemas/steering_policy'
              ttl:
                $ref: '#/components/schemas/schemas-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
          terminates:
            type: boolean
            description: If this rule's condition is true, this causes rule evaluation
              to stop after processing this rule.
            default: false
    load-balancer_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/load-balancer'
    load_shedding:
      type: object
      description: Configures load shedding policies and percentages for the pool.
      properties:
        default_percent:
          type: number
          description: The percent of traffic to shed from the pool, according to
            the default policy. Applies to new sessions and traffic without session
            affinity.
          default: 0
          minimum: 0
          maximum: 100
        default_policy:
          type: string
          description: The default policy to use when load shedding. A random policy
            randomly sheds a given percent of requests. A hash policy computes a hash
            over the CF-Connecting-IP address and sheds all requests originating from
            a percent of IPs.
          enum:
          - random
          - hash
          default: random
        session_percent:
          type: number
          description: The percent of existing sessions to shed from the pool, according
            to the session policy.
          default: 0
          minimum: 0
          maximum: 100
        session_policy:
          type: string
          description: Only the hash policy is supported for existing sessions (to
            avoid exponential decay).
          enum:
          - hash
          default: hash
    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
    locations:
      type: object
      properties:
        client_default:
          $ref: '#/components/schemas/client-default'
        created_at:
          $ref: '#/components/schemas/timestamp'
        doh_subdomain:
          $ref: '#/components/schemas/subdomain'
        ecs_support:
          $ref: '#/components/schemas/ecs-support'
        id:
          $ref: '#/components/schemas/locations_components-schemas-uuid'
        ip:
          $ref: '#/components/schemas/locations_components-schemas-ip'
        name:
          $ref: '#/components/schemas/locations_components-schemas-name'
        networks:
          $ref: '#/components/schemas/network'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    locations_components-schemas-empty_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    locations_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    locations_components-schemas-ip:
      type: string
      description: IPV6 destination ip assigned to this location. DNS requests sent
        to this IP will counted as the request under this location. (auto-generated).
      example: 2001:0db8:85a3:0000:0000:8a2e:0370:7334
    locations_components-schemas-name:
      type: string
      description: The name of the Location.
      example: Austin Office Location
    locations_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/locations'
    locations_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/locations'
    locations_components-schemas-uuid:
      example: ed35569b41ce4d1facfe683550f54086
    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
    lockdowns_components-schemas-id:
      type: string
      description: The unique identifier of the Zone Lockdown rule.
      example: 372e67954025e0ba6aaa6d586b9e0b59
      readOnly: true
      maxLength: 32
    lockdowns_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
    locked:
      type: boolean
      description: Shows whether a registrar lock is in place for a domain.
      example: false
    logging:
      type: object
      description: An object configuring the rule's logging behavior.
      example:
        enabled: true
      properties:
        enabled:
          type: boolean
          description: Whether to generate a log when the rule matches.
          example: true
    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'
    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
    logpull_options:
      type: string
      format: uri-reference
      description: 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
      maxLength: 4096
    logpush_components-schemas-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\-\.]*$
    logpush_field_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
            items:
              type: object
              nullable: true
              properties:
                key:
                  type: string
                  example: value
    logpush_job_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: array
            items:
              type: object
              nullable: true
    logpush_job_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            nullable: true
    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}
    longitude:
      type: number
      description: The longitude of the data center containing the origins used in
        this pool in decimal degrees. If this is set, latitude must also be set.
    mac_address:
      type: string
      description: The device mac address.
      example: 00-00-5E-00-53-00
    managed_headers_components-schemas-enabled:
      type: boolean
      description: When true, the Managed Transform is enabled.
      example: true
    managed_headers_components-schemas-id:
      type: string
      description: Human-readable identifier of the Managed Transform.
      example: add_cf-bot-score_header
    manufacturer:
      type: string
      description: The device manufacturer name.
      example: My phone corp
    match:
      oneOf:
      - type: object
        properties:
          headers:
            type: array
            items:
              type: object
              properties:
                name:
                  $ref: '#/components/schemas/header_name'
                op:
                  $ref: '#/components/schemas/header_op'
                value:
                  $ref: '#/components/schemas/header_value'
          request:
            type: object
            properties:
              methods:
                $ref: '#/components/schemas/methods'
              schemes:
                $ref: '#/components/schemas/schemes'
              url:
                $ref: '#/components/schemas/schemas-url'
          response:
            type: object
            properties:
              origin_traffic:
                $ref: '#/components/schemas/origin_traffic'
      type: object
      description: Determines which traffic the rate limit counts towards the threshold.
    match_item:
      type: object
      properties:
        platform:
          $ref: '#/components/schemas/platform'
    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
    matchers:
      type: array
      description: Matching patterns to forward to your actions.
      items:
        $ref: '#/components/schemas/matcher'
    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
    max_estimated_time_minutes:
      type: integer
    max_retries:
      type: number
      example: 3
    max_rtt_ms:
      type: number
      description: Maximum RTT in ms.
    max_ttl:
      type: integer
      description: Max TTL.
      default: 15
      minimum: 0
      maximum: 64
    max_upload:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: identifier of the zone setting.
            enum:
            - max_upload
            example: max_upload
          value:
            $ref: '#/components/schemas/max_upload_value'
      title: Max Upload
      description: Maximum size of an allowable upload.
    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
    max_wait_time_ms:
      type: number
      example: 5000
    maxDurationSeconds:
      type: integer
      description: The maximum duration in seconds for a video upload. Can be set
        for a video that is not yet uploaded to limit its duration. Uploads that exceed
        the specified duration will fail during processing. A value of `-1` means
        the value is unknown.
    maximum_cache_ttl:
      type: number
      description: Maximum DNS Cache TTL.
      default: 900
      example: 900
      minimum: 30
      maximum: 36000
    mean_rtt_ms:
      type: number
      description: Mean RTT in ms.
    mechanism:
      type: string
      description: The mechanism to which the notification has been dispatched.
      example: test@example.com
    mechanism_type:
      type: string
      description: The type of mechanism to which the notification has been dispatched.
        This can be email/pagerduty/webhook based on the mechanism configured.
      enum:
      - email
      - pagerduty
      - webhook
      example: email
    mechanisms:
      type: object
      description: List of IDs that will be used when dispatching a notification.
        IDs for email type will be the email address.
      example:
        email:
        - id: test@example.com
        pagerduty:
        - id: e8133a15-00a4-4d69-aec1-32f70c51f6e5
        webhooks:
        - id: 14cc1190-5d2b-4b98-a696-c424cb2ad05f
    media_metadata:
      type: object
      description: A user modifiable key-value store used to reference other systems
        of record for managing videos.
      example: {}
    media_state:
      type: string
      description: Specifies the processing status of the video.
      enum:
      - pendingupload
      - downloading
      - queued
      - inprogress
      - ready
      - error
      example: inprogress
      readOnly: true
    media_status:
      description: Specifies a detailed status for a video. If the `state` is `inprogress`
        or `error`, the `step` field returns `encoding` or `manifest`. If the `state`
        is `inprogress`, `pctComplete` returns a number between 0 and 100 to indicate
        the approximate percent of completion. If the `state` is `error`, `errorReasonCode`
        and `errorReasonText` provide additional details.
      readOnly: true
      properties:
        errorReasonCode:
          $ref: '#/components/schemas/errorReasonCode'
        errorReasonText:
          $ref: '#/components/schemas/errorReasonText'
        pctComplete:
          $ref: '#/components/schemas/pctComplete'
        state:
          $ref: '#/components/schemas/media_state'
    member:
      type: object
      required:
      - id
      - user
      - status
      - roles
      properties:
        code:
          $ref: '#/components/schemas/code'
        id:
          $ref: '#/components/schemas/membership_components-schemas-identifier'
        roles:
          type: array
          description: Roles assigned to this member.
          items:
            $ref: '#/components/schemas/role'
        status:
          readOnly: true
        user:
          type: object
          readOnly: true
          required:
          - email
          properties:
            email:
              $ref: '#/components/schemas/email'
            first_name:
              $ref: '#/components/schemas/first_name'
            id:
              $ref: '#/components/schemas/common_components-schemas-identifier'
            last_name:
              $ref: '#/components/schemas/last_name'
            two_factor_authentication_enabled:
              $ref: '#/components/schemas/two_factor_authentication_enabled'
    member_components-schemas-name:
      type: string
      description: Member Name.
      example: John Smith
      nullable: true
      maxLength: 100
    membership:
      type: object
      properties:
        account:
          $ref: '#/components/schemas/schemas-account'
        api_access_enabled:
          $ref: '#/components/schemas/api_access_enabled'
        code:
          $ref: '#/components/schemas/code'
        id:
          $ref: '#/components/schemas/membership_components-schemas-identifier'
        permissions:
          allOf:
          - $ref: '#/components/schemas/permissions'
          description: All access permissions for the user at the account.
          readOnly: true
        roles:
          $ref: '#/components/schemas/roles'
        status:
          $ref: '#/components/schemas/schemas-status'
    membership_components-schemas-identifier:
      type: string
      description: Membership identifier tag.
      example: 4536bcfad5faccb111b47003c79917fa
      readOnly: true
      maxLength: 32
    memberships:
      type: array
      description: Zones and Accounts which will be assigned IPs on this Address Map.
        A zone membership will take priority over an account membership.
      items:
        $ref: '#/components/schemas/address-maps-membership'
    messages:
      type: array
      example: []
      items:
        type: object
        uniqueItems: true
        required:
        - code
        - message
        properties:
          code:
            type: integer
            minimum: 1000
          message:
            type: string
    metadata:
      type: object
      description: User modifiable key-value store. Can be used for keeping references
        to another system of record for managing images. Metadata must not exceed
        1024 bytes.
      example:
        key: value
    method:
      type: string
      description: The HTTP method used to access the endpoint.
      enum:
      - GET
      - POST
      - HEAD
      - OPTIONS
      - PUT
      - DELETE
      - CONNECT
      - PATCH
      - TRACE
      example: GET
    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
    min_rtt_ms:
      type: number
      description: Minimum RTT in ms.
    min_tls_version:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - min_tls_version
            example: min_tls_version
          value:
            $ref: '#/components/schemas/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"
    min_tls_version_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "1.0"
      - "1.1"
      - "1.2"
      - "1.3"
      default: "1.0"
    minify:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: Zone setting identifier.
            enum:
            - minify
            example: minify
          value:
            $ref: '#/components/schemas/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.
    minify_value:
      type: object
      description: Value of the zone setting.
      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"
    minimum_cache_ttl:
      type: number
      description: Minimum DNS Cache TTL.
      default: 60
      example: 60
      minimum: 30
      maximum: 36000
    minimum_origins:
      type: integer
      description: The minimum number of origins that must be healthy for this pool
        to serve traffic. If the number of healthy origins falls below this number,
        the pool will be marked unhealthy and will failover to the next available
        pool.
      default: 1
    mirage:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - mirage
            example: mirage
          value:
            $ref: '#/components/schemas/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.
    mirage_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    miscategorization:
      properties:
        content_adds:
          description: Content category IDs to add.
          example:
          - 82
        content_removes:
          description: Content category IDs to remove.
          example:
          - 155
        indicator_type:
          enum:
          - domain
          - ipv4
          - ipv6
          - url
          example: domain
        ip:
          description: Provide only if indicator_type is `ipv4` or `ipv6`.
        security_adds:
          description: Security category IDs to add.
          example:
          - 117
          - 131
        security_removes:
          description: Security category IDs to remove.
          example:
          - 83
        url:
          type: string
          description: 'Provide only if indicator_type is `domain` or `url`. Example
            if indicator_type is `domain`: `example.com`. Example if indicator_type
            is `url`: `https://example.com/news/`.'
    mnm_config:
      type: object
      required:
      - name
      - default_sampling
      - router_ips
      properties:
        default_sampling:
          $ref: '#/components/schemas/mnm_config_default_sampling'
        name:
          $ref: '#/components/schemas/mnm_config_name'
        router_ips:
          $ref: '#/components/schemas/mnm_config_router_ips'
    mnm_config_default_sampling:
      type: number
      description: Fallback sampling rate of flow messages being sent in packets per
        second. This should match the packet sampling rate configured on the router.
      default: 1
      minimum: 1
    mnm_config_name:
      type: string
      description: The account name.
      example: cloudflare user's account
    mnm_config_router_ip:
      type: string
      description: IPv4 CIDR of the router sourcing flow data. Only /32 addresses
        are currently supported.
      example: 203.0.113.1/32
    mnm_config_router_ips:
      type: array
      items:
        $ref: '#/components/schemas/mnm_config_router_ip'
    mnm_rule:
      type: object
      required:
      - name
      - prefixes
      - automatic_advertisement
      - duration
      properties:
        automatic_advertisement:
          $ref: '#/components/schemas/mnm_rule_automatic_advertisement'
        bandwidth_threshold:
          $ref: '#/components/schemas/mnm_rule_bandwidth_threshold'
        duration:
          $ref: '#/components/schemas/mnm_rule_duration'
        id:
          $ref: '#/components/schemas/schemas-rule_identifier'
        name:
          $ref: '#/components/schemas/mnm_rule_name'
        packet_threshold:
          $ref: '#/components/schemas/mnm_rule_packet_threshold'
        prefixes:
          $ref: '#/components/schemas/mnm_rule_ip_prefixes'
    mnm_rule_automatic_advertisement:
      type: boolean
      description: Toggle on if you would like Cloudflare to automatically advertise
        the IP Prefixes within the rule via Magic Transit when the rule is triggered.
        Only available for users of Magic Transit.
      example: "false"
    mnm_rule_bandwidth_threshold:
      type: number
      description: The number of bits per second for the rule. When this value is
        exceeded for the set duration, an alert notification is sent. Minimum of 1
        and no maximum.
      example: 1000
      minimum: 1
    mnm_rule_duration:
      type: string
      description: The amount of time that the rule threshold must be exceeded to
        send an alert notification. The minimum is 60 seconds and maximum is 21600
        seconds. The format is XhYmZs where X, Y, and Z durations are optional; however
        at least one unit must be provided.
      default: 60s
      example: 1h2m3s
    mnm_rule_ip_prefix:
      type: string
      description: The IP prefixes that are monitored for this rule. Must be a CIDR
        range like 203.0.113.0/24. Max 5000 different CIDR ranges.
      example: 203.0.113.1/32
    mnm_rule_ip_prefixes:
      type: array
      items:
        $ref: '#/components/schemas/mnm_rule_ip_prefix'
    mnm_rule_name:
      type: string
      description: The name of the rule. Must be unique. Supports characters A-Z,
        a-z, 0-9, underscore (_), dash (-), period (.), and tilde (~). You can’t have
        a space in the rule name. Max 256 characters.
      example: my_rule_1
    mnm_rule_packet_threshold:
      type: number
      description: The number of packets per second for the rule. When this value
        is exceeded for the set duration, an alert notification is sent. Minimum of
        1 and no maximum.
      example: 10000
      minimum: 1
    mnm_rules:
      type: array
      items:
        $ref: '#/components/schemas/mnm_rule'
    mobile_redirect:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: Identifier of the zone setting.
            enum:
            - mobile_redirect
            example: mobile_redirect
          value:
            $ref: '#/components/schemas/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.
    mobile_redirect_value:
      type: object
      description: Value of the zone setting.
      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
    mode:
      type: string
      description: The action to perform.
      enum:
      - simulate
      - ban
      - challenge
      - js_challenge
      - managed_challenge
      example: challenge
    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"
    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"
    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
    model:
      type: string
      description: The device model name.
      example: MyPhone(pro-X)
    modified:
      type: string
      format: date-time
      description: The date and time the destination address was last modified.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    modified_at_nullable:
      type: string
      format: date-time
      description: Last time the advertisement status was changed. This field is only
        not 'null' if on demand is enabled.
      example: "2014-01-01T05:20:00.12345Z"
      nullable: true
    modified_on:
      type: string
      format: date-time
      description: Last time the token was modified.
      example: "2018-07-02T05:20:00Z"
      readOnly: true
    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
    modified_tunnels_collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              modified:
                type: boolean
                example: true
              modified_gre_tunnels:
                type: array
                items:
                  $ref: '#/components/schemas/gre-tunnel'
    modify_request:
      type: object
      properties:
        description:
          $ref: '#/components/schemas/web3-hostname_components-schemas-description'
        dnslink:
          $ref: '#/components/schemas/dnslink'
    monitor:
      type: object
      properties:
        allow_insecure:
          $ref: '#/components/schemas/allow_insecure'
        created_on:
          $ref: '#/components/schemas/timestamp'
        description:
          $ref: '#/components/schemas/monitor_components-schemas-description'
        expected_body:
          $ref: '#/components/schemas/expected_body'
        expected_codes:
          $ref: '#/components/schemas/expected_codes'
        follow_redirects:
          $ref: '#/components/schemas/follow_redirects'
        header:
          $ref: '#/components/schemas/header'
        id:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
        interval:
          $ref: '#/components/schemas/interval'
        method:
          $ref: '#/components/schemas/schemas-method'
        modified_on:
          $ref: '#/components/schemas/timestamp'
        path:
          $ref: '#/components/schemas/path'
        port:
          $ref: '#/components/schemas/components-schemas-port'
        retries:
          $ref: '#/components/schemas/retries'
        timeout:
          $ref: '#/components/schemas/schemas-timeout'
        type:
          $ref: '#/components/schemas/monitor_components-schemas-type'
    monitor_components-schemas-description:
      type: string
      description: Object description.
      example: Login page monitor
    monitor_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/monitor_components-schemas-identifier'
    monitor_components-schemas-identifier:
      example: f1aba936b94213e5b8dca0c0dbf1f9cc
    monitor_components-schemas-port:
      type: integer
      description: 'The port number to connect to for the health check. Required for
        TCP, UDP, and SMTP checks. HTTP and HTTPS checks should only define the port
        when using a non-standard port (HTTP: default 80, HTTPS: default 443).'
      default: 0
    monitor_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/monitor'
    monitor_components-schemas-response_collection-2:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/components-schemas-monitor'
    monitor_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/monitor'
    monitor_components-schemas-single_response-2:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/components-schemas-monitor'
    monitor_components-schemas-type:
      type: string
      description: The protocol to use for the health check. Currently supported protocols
        are 'HTTP','HTTPS', 'TCP', 'ICMP-PING', 'UDP-ICMP', and 'SMTP'.
      enum:
      - http
      - https
      - tcp
      - udp_icmp
      - icmp_ping
      - smtp
      default: http
      example: https
    mtu:
      type: integer
      description: Maximum Transmission Unit (MTU) in bytes for the GRE tunnel. The
        minimum value is 576.
      default: 1476
    multiple_route_modified_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              modified:
                type: boolean
                example: true
              modified_routes:
                type: array
                items:
                  $ref: '#/components/schemas/schemas-route'
    name:
      type: string
      description: Token name.
      example: readonly token
      maxLength: 120
    name_servers:
      type: array
      description: List of name servers.
      example:
      - preston.ns.cloudflare.com
      - oli.ns.cloudflare.com
      items:
        type: string
    namespace:
      type: object
      required:
      - id
      - title
      properties:
        id:
          $ref: '#/components/schemas/namespace_identifier'
        supports_url_encoding:
          type: boolean
          description: True if keys written on the URL will be URL-decoded before
            storing. For example, if set to "true", a key written on the URL as "%3F"
            will be stored as "?".
          example: true
          readOnly: true
        title:
          $ref: '#/components/schemas/namespace_title'
    namespace_identifier:
      type: string
      description: Namespace identifier tag.
      example: 0f2ac74b498b48028cb68387c421e279
      readOnly: true
      maxLength: 32
    namespace_title:
      type: string
      description: A human-readable string name for a Namespace.
      example: My Own Namespace
    namespaces_components-schemas-id:
      type: string
      description: ID of the namespace.
      example: 5fd1cafff895419c8bcc647fc64ab8f0
    negative_cache_ttl:
      type: number
      description: Negative DNS Cache TTL.
      example: 900
      nullable: true
      minimum: 30
      maximum: 36000
    nel:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: Zone setting identifier.
            enum:
            - nel
            example: nel
          value:
            $ref: '#/components/schemas/nel_value'
      title: Network Error Logging
      description: 'Enable Network Error Logging reporting on your zone. (Beta) '
    nel_value:
      type: object
      description: Value of the zone setting.
      properties:
        enabled:
          type: boolean
          default: false
          example: false
    network:
      type: array
      description: A list of network ranges that requests from this location would
        originate from.
      items:
        type: string
        description: The IPv4 address or IPv4 CIDR. IPv4 CIDRs are limited to a maximum
          of /24.
        example: 192.0.2.1/32
    neverRequireSignedURLs:
      type: boolean
      description: Indicates whether the variant can access an image without a signature,
        regardless of image access control.
      default: false
      example: true
    new-project-response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
    new_custom_entry:
      type: object
      title: Custom entry
      description: A custom entry create payload
      required:
      - name
      - enabled
      - pattern
      properties:
        enabled:
          type: boolean
          description: Whether the entry is enabled or not.
          example: true
        name:
          type: string
          description: The name of the entry.
          example: Credit card (Visa)
        pattern:
          $ref: '#/components/schemas/components-schemas-pattern'
    new_custom_profile:
      type: object
      properties:
        description:
          type: string
          description: The description of the profile.
          example: A standard CVV card number
        entries:
          type: array
          description: The entries for this profile.
          items:
            $ref: '#/components/schemas/new_custom_entry'
        name:
          type: string
          description: The name of the profile.
          example: Generic CVV Card Number
    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: 2.147483647e+09
    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
    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
    nexthop:
      type: string
      description: The next-hop IP Address for the static route.
      example: 203.0.113.1
    nft:
      type: object
      readOnly: true
      properties:
        contract:
          type: string
          description: The ERC-721 compatible contract address.
          example: 0x57f1887a8bf19b14fc0d912b9b2acc9af147ea85
          readOnly: true
          minLength: 42
          maxLength: 42
        token:
          type: integer
          description: The token ID for the NFT.
          readOnly: true
    node_result:
      type: object
      example:
        asn: AS13335
        ip: 1.1.1.1
        max_latency_ms: 0.034
        mean_latency_ms: 0.021
        min_latency_ms: 0.014
        name: one.one.one.one
        packet_count: 3
        std_dev_latency_ms: 0.011269427669584647
      properties:
        asn:
          $ref: '#/components/schemas/schemas-asn'
        ip:
          $ref: '#/components/schemas/traceroute_components-schemas-ip'
        labels:
          $ref: '#/components/schemas/labels'
        max_rtt_ms:
          $ref: '#/components/schemas/max_rtt_ms'
        mean_rtt_ms:
          $ref: '#/components/schemas/mean_rtt_ms'
        min_rtt_ms:
          $ref: '#/components/schemas/min_rtt_ms'
        name:
          $ref: '#/components/schemas/traceroute_components-schemas-name'
        packet_count:
          $ref: '#/components/schemas/packet_count'
        std_dev_rtt_ms:
          $ref: '#/components/schemas/std_dev_rtt_ms'
    not_before:
      type: string
      format: date-time
      description: The time before which the token MUST NOT be accepted for processing.
      example: "2018-07-01T05:20:00Z"
    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.
    notification_email:
      type: string
      description: The email address to send health status notifications to. This
        can be an individual mailbox or a mailing list. Multiple emails can be supplied
        as a comma delimited list.
      example: someone@example.com,sometwo@example.com
    notification_filter:
      type: object
      description: Filter pool and origin health notifications by resource type or
        health status. Use null to reset.
      example:
        origin:
          disable: true
        pool:
          healthy: false
      nullable: true
      properties:
        origin:
          $ref: '#/components/schemas/filter_options'
        pool:
          $ref: '#/components/schemas/filter_options'
    notificationUrl:
      type: string
      format: uri
      description: The URL where webhooks will be sent.
      example: https://example.com
    ns_name:
      type: string
      format: hostname
      description: The FQDN of the name server.
      example: ns1.example.com
    num_items:
      type: number
      description: The number of items in the list.
      example: 10
    num_referencing_filters:
      type: number
      description: The number of [filters](#filters) referencing the list.
      example: 2
    object:
      type: object
      properties:
        hasStoredData:
          type: boolean
          description: Whether the Durable Object has stored data.
          example: true
          readOnly: true
        id:
          type: string
          description: ID of the Durable Object.
          example: fe7803fc55b964e09d94666545aab688d360c6bda69ba349ced1e5f28d2fc2c8
          readOnly: true
    occurred_at:
      type: string
      format: date-time
      description: When the billing item was created.
      example: "2014-03-01T12:21:59.3456Z"
      readOnly: true
    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
    on_demand_enabled:
      type: boolean
      description: Whether advertisement of the prefix to the Internet may be dynamically
        enabled or disabled.
      example: true
    on_demand_locked:
      type: boolean
      description: Whether advertisement status of the prefix is locked, meaning it
        cannot be changed.
      example: false
    oneTimeUploadExpiry:
      type: string
      format: date-time
      description: The date and time when the video upload URL is no longer valid
        for direct user uploads.
      example: "2014-01-02T02:20:00Z"
    opacity:
      type: number
      description: The translucency of the image. A value of `0.0` makes the image
        completely transparent, and `1.0` makes the image completely opaque. Note
        that if the image is already semi-transparent, setting this to `1.0` will
        not make the image completely opaque.
      default: 1
      example: 0.75
      readOnly: true
      minimum: 0
      maximum: 1
    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
    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
    operation:
      type: object
      required:
      - operation_id
      - method
      - host
      - endpoint
      - last_updated
      properties:
        endpoint:
          $ref: '#/components/schemas/endpoint'
        features:
          $ref: '#/components/schemas/features'
        host:
          $ref: '#/components/schemas/host'
        last_updated:
          $ref: '#/components/schemas/timestamp'
        method:
          $ref: '#/components/schemas/method'
        operation_id:
          $ref: '#/components/schemas/operation_id'
    operation_id:
      description: The ID that identifies the API operation.
    opportunistic_encryption:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - opportunistic_encryption
            example: opportunistic_encryption
          value:
            $ref: '#/components/schemas/opportunistic_encryption_value'
      title: Enable Opportunistic Encryption for a zone
      description: Enables the Opportunistic Encryption feature for a zone.
    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"
    opportunistic_onion:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - opportunistic_onion
            example: opportunistic_onion
          value:
            $ref: '#/components/schemas/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"
    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"
    options:
      type: object
      description: Allows you to define image resizing sizes for different use cases.
      required:
      - fit
      - metadata
      - width
      - height
      properties:
        fit:
          $ref: '#/components/schemas/fit'
        height:
          $ref: '#/components/schemas/schemas-height'
        metadata:
          $ref: '#/components/schemas/schemas-metadata'
        width:
          $ref: '#/components/schemas/schemas-width'
    orange_to_orange:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - orange_to_orange
            example: orange_to_orange
          value:
            $ref: '#/components/schemas/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.
    orange_to_orange_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "on"
    organization:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/schemas-name'
        permissions:
          $ref: '#/components/schemas/schemas-permissions'
        roles:
          type: array
          description: List of roles that a user has within an organization.
          readOnly: true
          items:
            type: string
            example: All Privileges - Super Administrator
            maxLength: 120
        status:
          $ref: '#/components/schemas/components-schemas-status'
    organization_components-schemas-identifier:
      type: string
      description: Organization identifier tag.
      example: 01a7362d577a6c3019a474fd6f485823
      readOnly: true
      maxLength: 32
    organization_invite:
      allOf:
      - $ref: '#/components/schemas/base'
      - properties:
          organization_is_enforcing_twofactor:
            type: boolean
            description: Current status of two-factor enforcement on the organization.
            default: false
            example: true
          status:
            type: string
            description: Current status of the invitation.
            enum:
            - pending
            - accepted
            - rejected
            - canceled
            - left
            - expired
            example: accepted
    organizations:
      type: object
      properties:
        auth_domain:
          $ref: '#/components/schemas/auth_domain'
        created_at:
          $ref: '#/components/schemas/timestamp'
        is_ui_read_only:
          $ref: '#/components/schemas/is_ui_read_only'
        login_design:
          $ref: '#/components/schemas/login_design'
        name:
          $ref: '#/components/schemas/organizations_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    organizations_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    organizations_components-schemas-name:
      type: string
      description: The name of your Zero Trust organization.
      example: Widget Corps Internal Applications
    organizations_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/organizations'
    origin:
      type: string
      description: Your origin hostname that requests to your custom hostnames will
        be sent to.
      example: fallback.example.com
      maxLength: 255
    origin_components-schemas-enabled:
      type: boolean
      description: Whether to enable (the default) this origin within the pool. Disabled
        origins will not receive traffic and are excluded from health checks. The
        origin will only be disabled for the current pool.
      default: true
      example: true
    origin_components-schemas-name:
      type: string
      description: A human-identifiable name for the origin.
      example: app-server-1
    origin_dns:
      type: object
      description: The name and type of DNS record for the Spectrum application.
      properties:
        name:
          $ref: '#/components/schemas/origin_dns_name'
        ttl:
          $ref: '#/components/schemas/dns_ttl'
        type:
          $ref: '#/components/schemas/origin_dns_type'
    origin_dns_name:
      type: string
      format: hostname
      description: The name of the DNS record associated with the origin.
      example: origin.example.com
    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: ""
    origin_error_page_pass_thru:
      allOf:
      - $ref: '#/components/schemas/schemas-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/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"
    origin_error_page_pass_thru_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    origin_ips:
      type: array
      example:
      - 192.0.2.1
      - 198.51.100.1
      - 2001:DB8:100::CF
      items:
        anyOf:
        - type: string
          format: ipv4
          description: Origin DNS Server IPv4 Address.
          example: 192.0.2.1
        - type: string
          format: ipv6
          description: Origin DNS Server IPv6 Address.
          example: 2001:DB8:100::CF
    origin_max_http_version:
      allOf:
      - required:
        - id
        properties:
          id:
            description: Identifier of the zone setting.
            enum:
            - origin_max_http_version
            example: origin_max_http_version
          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
      title: Origin Max HTTP version
      description: 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.).
    origin_max_http_version_response_value:
      properties:
        result:
          allOf:
          - $ref: '#/components/schemas/origin_max_http_version'
          - required:
            - value
            properties:
              value:
                $ref: '#/components/schemas/origin_max_http_version_value'
    origin_max_http_version_value:
      type: string
      description: Value of the Origin Max HTTP version setting (Note that the default
        value for Enterprise is "1").
      enum:
      - "1"
      - "2"
      default: "2"
    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
    origin_steering:
      type: object
      description: Configures origin steering for the pool. Controls how origins are
        selected for new sessions and traffic without session affinity.
      properties:
        policy:
          type: string
          description: The type of origin steering policy to use, either "random"
            or "hash" (based on CF-Connecting-IP).
          enum:
          - random
          - hash
          default: random
    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.
    original_url:
      type: string
      format: uri
      description: URI to original variant for an image.
      example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original
      readOnly: true
    origins:
      type: array
      description: The list of origins within this pool. Traffic directed at this
        pool is balanced across all currently healthy origins, provided the pool itself
        is healthy.
      items:
        $ref: '#/components/schemas/schemas-origin'
    os_distro_name:
      type: string
      description: The Linux distro name.
      example: ubuntu
    os_distro_revision:
      type: string
      description: The Linux distro revision.
      example: 1.0.0
    os_version:
      type: string
      description: The operating system version.
      example: 10.0.0
    output:
      properties:
        enabled:
          $ref: '#/components/schemas/output_enabled'
        streamKey:
          $ref: '#/components/schemas/output_streamKey'
        uid:
          $ref: '#/components/schemas/output_identifier'
        url:
          $ref: '#/components/schemas/output_url'
    output_enabled:
      type: boolean
      description: When enabled, live video streamed to the associated live input
        will be sent to the output URL. When disabled, live video will not be sent
        to the output URL, even when streaming to the associated live input. Use this
        to control precisely when you start and stop simulcasting to specific destinations
        like YouTube and Twitch.
      default: true
      example: true
    output_identifier:
      type: string
      description: A unique identifier for the output.
      example: baea4d9c515887b80289d5c33cf01145
      readOnly: true
      maxLength: 32
    output_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/output'
    output_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/output'
    output_streamKey:
      type: string
      description: The streamKey used to authenticate against an output's target.
      example: uzya-f19y-g2g9-a2ee-51j2
      readOnly: true
    output_url:
      type: string
      description: The URL an output uses to restream.
      example: rtmp://a.rtmp.youtube.com/live2
      readOnly: true
    override:
      properties:
        description:
          $ref: '#/components/schemas/overrides_components-schemas-description'
        groups:
          $ref: '#/components/schemas/groups'
        id:
          $ref: '#/components/schemas/overrides_components-schemas-id'
        paused:
          $ref: '#/components/schemas/schemas-paused'
        priority:
          $ref: '#/components/schemas/overrides_components-schemas-priority'
        rewrite_action:
          $ref: '#/components/schemas/rewrite_action'
        rules:
          $ref: '#/components/schemas/schemas-rules'
        urls:
          $ref: '#/components/schemas/urls'
    override_codes_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: object
            properties:
              disable_for_time:
                $ref: '#/components/schemas/disable_for_time'
    override_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        required:
        - result
        properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/override'
              - type: object
                required:
                - id
                - paused
                - urls
                - priority
    override_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        required:
        - result
        properties:
          result:
            $ref: '#/components/schemas/override'
    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
    overrides_components-schemas-id:
      type: string
      description: The unique identifier of the WAF override.
      example: de677e5818985db1285d0e80225f06e5
      readOnly: true
      maxLength: 32
    overrides_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: -1e+09
      maximum: 1e+09
    ownership_challenge:
      type: string
      description: Ownership challenge token to prove destination ownership.
      example: "00000000000000000000"
      maxLength: 4096
      pattern: ^[a-zA-Z0-9/\+\.\-_]*$
    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.
    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.
    p50:
      type: integer
      description: The p50 quantile of requests (in period_seconds).
      readOnly: true
    p90:
      type: integer
      description: The p90 quantile of requests (in period_seconds).
      readOnly: true
    p99:
      type: integer
      description: The p99 quantile of requests (in period_seconds).
      readOnly: true
    package:
      oneOf:
      - $ref: '#/components/schemas/package_definition'
      - $ref: '#/components/schemas/anomaly_package'
      type: object
    package_components-schemas-description:
      type: string
      description: A summary of the purpose/function of the WAF package.
      example: "null"
      readOnly: true
    package_components-schemas-identifier:
      type: string
      description: The unique identifier of a WAF package.
      example: a25a9a7e9c00afc1fb2e0245519d725b
      readOnly: true
      maxLength: 32
    package_components-schemas-name:
      type: string
      description: The name of the WAF package.
      example: USER
      readOnly: true
    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
    package_definition:
      title: Traditional WAF package
      required:
      - id
      - name
      - description
      - detection_mode
      - zone_id
      properties:
        description:
          $ref: '#/components/schemas/package_components-schemas-description'
        detection_mode:
          $ref: '#/components/schemas/detection_mode'
        id:
          $ref: '#/components/schemas/package_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/package_components-schemas-name'
        status:
          $ref: '#/components/schemas/package_components-schemas-status'
        zone_id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
    package_response_collection:
      anyOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/package'
    package_response_single:
      oneOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    packet_count:
      type: integer
      description: Number of packets with a response from this node.
    packet_type:
      type: string
      description: Type of packet sent.
      enum:
      - icmp
      - tcp
      - udp
      - gre
      - gre+icmp
      default: icmp
      example: icmp
    packets_lost:
      type: integer
      description: Number of packets where no response was received.
    packets_per_ttl:
      type: integer
      description: Number of packets sent at each TTL.
      default: 3
      minimum: 0
      maximum: 10
    packets_sent:
      type: integer
      description: Number of packets sent with specified TTL.
    packets_ttl:
      type: integer
      description: The time to live (TTL).
    padding:
      type: number
      description: The whitespace between the adjacent edges (determined by position)
        of the video and the image. `0.0` indicates no padding, and `1.0` indicates
        a fully padded video width or length, as determined by the algorithm.
      default: 0.05
      example: 0.1
      readOnly: true
      minimum: 0
      maximum: 1
    page:
      type: number
      description: Current page within paginated list of results.
      example: 1
    page-rule:
      type: object
      required:
      - id
      - targets
      - actions
      - priority
      - status
      - modified_on
      - created_on
      properties:
        actions:
          $ref: '#/components/schemas/schemas-actions'
        created_on:
          $ref: '#/components/schemas/created_on'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        modified_on:
          $ref: '#/components/schemas/page-rule_components-schemas-modified_on'
        priority:
          $ref: '#/components/schemas/page-rule_components-schemas-priority'
        status:
          $ref: '#/components/schemas/page-rule_components-schemas-status'
        targets:
          $ref: '#/components/schemas/targets'
    page-rule_components-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
    page-rule_components-schemas-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
    page-rule_components-schemas-status:
      type: string
      description: The status of the Page Rule.
      enum:
      - active
      - disabled
      default: disabled
      example: active
    pagerduty:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/uuid'
        name:
          $ref: '#/components/schemas/pagerduty_components-schemas-name'
    pagerduty_components-schemas-name:
      type: string
      description: The name of the pagerduty service.
      example: My PagerDuty Service
    pagerduty_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/pagerduty'
    pagerule_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/page-rule'
    pagerule_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    pagerule_settings_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            $ref: '#/components/schemas/settings'
    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
    passive-dns-by-ip:
      properties:
        count:
          type: number
          description: Total results returned based on your search parameters.
          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
        reverse_records:
          type: array
          description: Reverse DNS look-ups observed during the time period.
          items:
            type: object
            properties:
              first_seen:
                type: string
                format: date
                description: First seen date of the DNS record during the time period.
                example: "2021-04-01"
              hostname:
                description: Hostname that the IP was observed resolving to.
              last_seen:
                type: string
                format: date
                description: Last seen date of the DNS record during the time period.
                example: "2021-04-30"
    passive-dns-by-ip_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/passive-dns-by-ip'
    patch:
      type: object
      description: Update enablement of Argo Smart Routing
      required:
      - value
      properties:
        value:
          $ref: '#/components/schemas/schemas-value'
    patch_pools_notification_email:
      type: string
      description: The email address to send health status notifications to. This
        field is now deprecated in favor of Cloudflare Notifications for Load Balancing,
        so only resetting this field with an empty string `""` is accepted.
      enum:
      - '""'
      example: ""
    patch_rule:
      required:
      - action
      - expression
      properties:
        action:
          $ref: '#/components/schemas/rule_action'
        description:
          $ref: '#/components/schemas/rule_description'
        enabled:
          $ref: '#/components/schemas/rule_enabled'
        expression:
          $ref: '#/components/schemas/rule_expression'
        position:
          $ref: '#/components/schemas/rule_position'
    path:
      type: string
      description: The endpoint path you want to conduct a health check against. This
        parameter is only valid for HTTP and HTTPS monitors.
      default: /
      example: /health
    pattern:
      type: string
      title: Route pattern
      example: example.net/*
    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
    pcaps_byte_limit:
      type: number
      description: The maximum number of bytes to capture. This field only applies
        to `full` packet captures.
      example: 500000
      minimum: 1
      maximum: 1e+09
    pcaps_collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              anyOf:
              - $ref: '#/components/schemas/pcaps_response_simple'
              - $ref: '#/components/schemas/pcaps_response_full'
    pcaps_colo_name:
      type: string
      description: The name of the data center used for the packet capture. This can
        be a specific colo (ord02) or a multi-colo name (ORD). This field only applies
        to `full` packet captures.
      example: ord02
    pcaps_destination_conf:
      type: string
      description: The full URI for the bucket. This field only applies to `full`
        packet captures.
      example: s3://pcaps-bucket?region=us-east-1
    pcaps_error_message:
      type: string
      description: An error message that describes why the packet capture failed.
        This field only applies to `full` packet captures.
      example: No packets matched the filter in the time limit given. Please modify
        the filter or try again.
    pcaps_filter_v1:
      type: object
      description: The packet capture filter. When this field is empty, all packets
        are captured.
      properties:
        destination_address:
          type: string
          description: The destination IP address of the packet.
          example: 1.2.3.4
        destination_port:
          type: number
          description: The destination port of the packet.
          example: 80
        protocol:
          type: number
          description: The protocol number of the packet.
          example: 6
        source_address:
          type: string
          description: The source IP address of the packet.
          example: 1.2.3.4
        source_port:
          type: number
          description: The source port of the packet.
          example: 123
    pcaps_id:
      type: string
      description: The ID for the packet capture.
      example: 66802ca5668e47a2b82c2e6746e45037
      minLength: 32
      maxLength: 32
    pcaps_ownership_challenge:
      type: string
      description: The ownership challenge filename stored in the bucket.
      example: ownership-challenge-9883874ecac311ec8475433579a6bf5f.txt
    pcaps_ownership_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            nullable: true
            items:
              $ref: '#/components/schemas/pcaps_ownership_response'
    pcaps_ownership_request:
      type: object
      required:
      - destination_conf
      properties:
        destination_conf:
          $ref: '#/components/schemas/pcaps_destination_conf'
    pcaps_ownership_response:
      type: object
      required:
      - id
      - status
      - submitted
      - destination_conf
      - filename
      properties:
        destination_conf:
          $ref: '#/components/schemas/pcaps_destination_conf'
        filename:
          $ref: '#/components/schemas/pcaps_ownership_challenge'
        id:
          type: string
          description: The bucket ID associated with the packet captures API.
          example: 9883874ecac311ec8475433579a6bf5f
          minLength: 32
          maxLength: 32
        status:
          type: string
          description: The status of the ownership challenge. Can be pending, success
            or failed.
          enum:
          - pending
          - success
          - failed
          example: success
        submitted:
          type: string
          description: The RFC 3339 timestamp when the bucket was added to packet
            captures API.
          example: "2020-01-01T08:00:00Z"
        validated:
          type: string
          description: The RFC 3339 timestamp when the bucket was validated.
          example: "2020-01-01T08:00:00Z"
    pcaps_ownership_single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            $ref: '#/components/schemas/pcaps_ownership_response'
    pcaps_ownership_validate_request:
      type: object
      required:
      - destination_conf
      - ownership_challenge
      properties:
        destination_conf:
          $ref: '#/components/schemas/pcaps_destination_conf'
        ownership_challenge:
          $ref: '#/components/schemas/pcaps_ownership_challenge'
    pcaps_packet_limit:
      type: number
      description: The limit of packets contained in a packet capture.
      example: 10000
      minimum: 1
      maximum: 10000
    pcaps_request_full:
      type: object
      required:
      - time_limit
      - type
      - system
      - colo_name
      - destination_conf
      properties:
        byte_limit:
          $ref: '#/components/schemas/pcaps_byte_limit'
        colo_name:
          $ref: '#/components/schemas/pcaps_colo_name'
        destination_conf:
          $ref: '#/components/schemas/pcaps_destination_conf'
        filter_v1:
          $ref: '#/components/schemas/pcaps_filter_v1'
        packet_limit:
          $ref: '#/components/schemas/pcaps_packet_limit'
        system:
          $ref: '#/components/schemas/pcaps_system'
        time_limit:
          $ref: '#/components/schemas/pcaps_time_limit'
        type:
          $ref: '#/components/schemas/pcaps_type'
    pcaps_request_pcap:
      anyOf:
      - $ref: '#/components/schemas/pcaps_request_simple'
      - $ref: '#/components/schemas/pcaps_request_full'
    pcaps_request_simple:
      type: object
      required:
      - time_limit
      - packet_limit
      - type
      - system
      properties:
        filter_v1:
          $ref: '#/components/schemas/pcaps_filter_v1'
        packet_limit:
          $ref: '#/components/schemas/pcaps_packet_limit'
        system:
          $ref: '#/components/schemas/pcaps_system'
        time_limit:
          $ref: '#/components/schemas/pcaps_time_limit'
        type:
          $ref: '#/components/schemas/pcaps_type'
    pcaps_response_full:
      type: object
      properties:
        byte_limit:
          $ref: '#/components/schemas/pcaps_byte_limit'
        colo_name:
          $ref: '#/components/schemas/pcaps_colo_name'
        destination_conf:
          $ref: '#/components/schemas/pcaps_destination_conf'
        error_message:
          $ref: '#/components/schemas/pcaps_error_message'
        filter_v1:
          $ref: '#/components/schemas/pcaps_filter_v1'
        id:
          $ref: '#/components/schemas/pcaps_id'
        status:
          $ref: '#/components/schemas/pcaps_status'
        submitted:
          $ref: '#/components/schemas/pcaps_submitted'
        system:
          $ref: '#/components/schemas/pcaps_system'
        time_limit:
          $ref: '#/components/schemas/pcaps_time_limit'
        type:
          $ref: '#/components/schemas/pcaps_type'
    pcaps_response_simple:
      type: object
      properties:
        filter_v1:
          $ref: '#/components/schemas/pcaps_filter_v1'
        id:
          $ref: '#/components/schemas/pcaps_id'
        status:
          $ref: '#/components/schemas/pcaps_status'
        submitted:
          $ref: '#/components/schemas/pcaps_submitted'
        system:
          $ref: '#/components/schemas/pcaps_system'
        time_limit:
          $ref: '#/components/schemas/pcaps_time_limit'
        type:
          $ref: '#/components/schemas/pcaps_type'
    pcaps_single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            anyOf:
            - $ref: '#/components/schemas/pcaps_response_simple'
            - $ref: '#/components/schemas/pcaps_response_full'
    pcaps_status:
      type: string
      description: The status of the packet capture request.
      enum:
      - unknown
      - success
      - pending
      - running
      - conversion_pending
      - conversion_running
      - complete
      - failed
      example: success
    pcaps_submitted:
      type: string
      description: The RFC 3339 timestamp when the packet capture was created.
      example: "2020-01-01T08:00:00Z"
    pcaps_system:
      type: string
      description: The system used to collect packet captures.
      enum:
      - magic-transit
      example: magic-transit
    pcaps_time_limit:
      type: number
      description: The packet capture duration in seconds.
      example: 300
      minimum: 1
      maximum: 300
    pcaps_type:
      type: string
      description: The type of packet capture. `Simple` captures sampled packets,
        and `full` captures entire payloads and non-sampled packets.
      enum:
      - simple
      - full
      example: simple
    pctComplete:
      type: string
      description: Indicates the size of the entire upload in bytes. The value must
        be a non-negative integer.
      readOnly: true
      minimum: 0
      maximum: 100
    peer:
      type: object
      required:
      - id
      - name
      properties:
        id:
          $ref: '#/components/schemas/peer_components-schemas-identifier'
        ip:
          $ref: '#/components/schemas/ip'
        ixfr_enable:
          $ref: '#/components/schemas/ixfr_enable'
        name:
          $ref: '#/components/schemas/peer_components-schemas-name'
        port:
          $ref: '#/components/schemas/port'
        tsig_id:
          $ref: '#/components/schemas/tsig_id'
    peer_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/peer_components-schemas-identifier'
    peer_components-schemas-identifier:
      example: 23ff594956f20c2a721606e94745a8aa
    peer_components-schemas-name:
      type: string
      description: The name of the peer.
      example: my-peer-1
    peer_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/peer'
    peer_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/peer'
    peers:
      type: array
      description: A list of peer tags.
      example:
      - 23ff594956f20c2a721606e94745a8aa
      - 00920f38ce07c2e2f4df50b1f61d4194
      items: {}
    pem:
      type: string
      description: The signing key in PEM format.
      example: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcGdJQkFBS0NBUUVBMFRqd2pPaVpXbUo0M3ZmM1RvNERvWG1YV3RKR05HeVhmaHl0dExhQmdGMStFUVdRCkRLaG9LYm9hS21xakNBc21za3V0YkxVN1BVOGRrUU5ER1p3S3VWczA4elNaNGt4aTR0RWdQUFp5dDdkWEMrbFkKUllveXJBR0Y0QVhoeTMyOWJIQ1AxSWxyQkIvQWtHZ25kTEFndW54WTByUmdjdk96aWF3NktKeEZuYzJVSzBXVQo4YjBwNEtLSEdwMUtMOWRrMFdUOGRWWXFiZVJpSmpDbFVFbWg4eXY5Q2xPVmFTNEt4aVg2eFRRNERadzZEYUpmCklWM1F0Tmd2cG1ieWxOSmFQSG5zc3JodDJHS1A5NjJlS2poUVJsaWd2SFhKTE9uSm9KZkxlSUVIWitpeFdmY1QKRE1IOTJzR3ZvdzFET2p4TGlDTjF6SEsraDdiTG9YVGlMZ2M0a3dJREFRQUJBb0lCQVFEQ0lCclNJMTlteGNkdwoycExVaUdCR0N4T3NhVDVLbGhkYUpESG9ZdzUxbEVuTWNXVGUyY01NTkdqaXdsN1NyOFlQMkxmcERaOFJtNzdMCk5rT2tGMnk3M3l5YUhFeEw5S1FyMys0Um9ubCtqTlp2YnV0QVdxSDVodEE0dER4MUd3NE85OEg4YWlTcGh1eWQKRUliTGRrQm54OGlDZUdxbFBnbHZ6Q1dLV0xVZlhGbXplMkF5UjBzaWMyYXZRLzZyclYwb3pDdGQ1T0Vod093agphaCs3N1dZV1l0bkEraDhXZVZreWcvdG44UTJJOXo5ZVJYdlZxR2sxMDZLcWRtZFdiU2tIZzA4cFRUSGhVM2paCnMvZGNjdEdOMWFFanlUQWY0QzdHT2lrcUd1MGFTaW1aeDFOM2RWQzBobngySjJtdlhNQ0VtZ0g3TjVnZUxWUFAKOWdkQjdBQkJBb0dCQU5sT2hGQVhaTHV6Y0Ftczl1K3AxM05STWRFOHpIK2ZFaFBrbk9zZ21Xb3VqUzkxQTRtZgpuK01oN3d5bTZoVU1DbDk2WUNMNGtPM0RUMmlYWlRqTXZuMHBoVEx1MXNYcGxWNDJuamRnZGd3cFBEM0FnL1Y5ClVvV2hxdVhoa1I3RFpsUGg5Nmk1aEE0M1BvbTVPQm9BektJbEcrT3ZKUkhhZEVveC9jSmZScFd2QW9HQkFQWjUKNnNmWDdESElCNEtBczRmMWRuNGZJUkMweUF2WVdCL1R3UzZHUWVoNFRFbDVuSkQwWk9ZRVdUbVVBK3pPanZTNApuM09tZ2xNQTU5SGd1ZW13QXVRcEtwWFBOcFUvTERJaThtNnpmTUpvL3E5M0NOQlFQZngzZGh4ZVh4OXE2Mzg3Cm84QWxkOE42RGs4TThjRis3SlNaeUVJODJzLzdpdGRseXA2bFdLaGRBb0dCQUtnU0VrUGYxQWxZdjA2OGVFRGwKRzc0VkRuTEdrMlFobzltKzk1N2psOFNJUEtwMzFrU2JNUTU3TUdpWXNIT1czRzc4TjE3VTRVTUR6R2NZc1RFOQpLaGVrQldGZldMMjU2OHp5Y1d4akx1bzQrbDdJaDBkWHBudTBqbms5L1AvT0lWYS9iczBRcnhKUHFBN2RNb2JxCkYxdFJXRURCTmVxWkMxaFhVZTBEdzVRQkFvR0JBSjdBQ2NNcnhKcVBycDZVakkyK1FOS2M5Q3dSZEdPRXRjWFMKR3JQL2owWE83YnZKVTFsZHYvc1N3L0U4NzRZL3lIM0F5QnF5SFhDZXZiRkZZQmt1MzczYThlM0pwK3RhNC9scQozdUVFUkEvbmxscW5mWXJHbEJZZlQzaVlKQVpWVkZiL3I4bWJtRmJVTDVFazBqV0JyWmxNcjFwU1hkRGx3QmhhCkhMWXY0em1WQW9HQkFLQmw0cFNnbkNSTEJMUU9jWjhXQmhRSjAwZDZieFNrTGNpZ0xUNFJvY3RwNTY1SHJPMDAKSVFLdElTaEg1a2s3SVRHdUYvOERXZEN2djBMYnhvZVBJc2NFaStTaXk5WDZwWENPaS8xa2FyYVU5U3BpZ3czago3YjVlUVV0UlovTkIycVJwc3EzMEdCUENqanhudEVmK2lqelhUS0xNRndyUDhBMTlQNzRONGVTMAotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=
      readOnly: true
    per_page:
      type: number
      description: Number of results per page of results.
      example: 20
    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
    period_seconds:
      type: integer
      description: The period over which this threshold is suggested.
      readOnly: true
    permission_group:
      type: object
      description: A named group of permissions that map to a group of operations
        against resources.
      required:
      - id
      properties:
        id:
          type: string
          description: Identifier of the group.
          example: 6d7f2f5f5b1d4a0e9081fdc98d432fd1
          readOnly: true
        name:
          type: string
          description: Name of the group.
          example: Load Balancers Write
          readOnly: true
    permission_groups:
      type: array
      description: A set of permission groups that are specified to the policy.
      example:
      - id: c8fed203ed3043cba015a93ad1616f1f
        name: Zone Read
      - id: 82e64a83756745bbbb1c9c2701bf816b
        name: DNS Read
      items:
        $ref: '#/components/schemas/permission_group'
    permissions:
      type: object
      example:
        analytics:
          read: true
          write: false
        zones:
          read: true
          write: true
      properties:
        analytics:
          $ref: '#/components/schemas/grants'
        billing:
          $ref: '#/components/schemas/grants'
        cache_purge:
          $ref: '#/components/schemas/grants'
        dns:
          $ref: '#/components/schemas/grants'
        dns_records:
          $ref: '#/components/schemas/grants'
        lb:
          $ref: '#/components/schemas/grants'
        logs:
          $ref: '#/components/schemas/grants'
        organization:
          $ref: '#/components/schemas/grants'
        ssl:
          $ref: '#/components/schemas/grants'
        waf:
          $ref: '#/components/schemas/grants'
        zone_settings:
          $ref: '#/components/schemas/grants'
        zones:
          $ref: '#/components/schemas/grants'
    phase:
      type: string
      description: The phase of the ruleset.
      example: http_request_firewall_managed
      pattern: ^[a-z_]+$
    phishing-url-info:
      properties:
        categorizations:
          type: array
          description: List of categorizations applied to this submission.
          items:
            type: object
            properties:
              category:
                type: string
                description: Name of the category applied.
                example: PHISHING
              verification_status:
                type: string
                description: Result of human review for this categorization.
                example: confirmed
        model_results:
          type: array
          description: List of model results for completed scans.
          items:
            type: object
            properties:
              model_name:
                type: string
                description: Name of the model.
                example: MACHINE_LEARNING_v2
              model_score:
                type: number
                description: Score output by the model for this submission.
                example: 0.024
        rule_matches:
          type: array
          description: List of signatures that matched against site content found
            when crawling the URL.
          items:
            type: object
            properties:
              banning:
                type: boolean
                description: For internal use.
              blocking:
                type: boolean
                description: For internal use.
              description:
                type: string
                description: Description of the signature that matched.
                example: Match frequently used social followers phishing kit
              name:
                type: string
                description: Name of the signature that matched.
                example: phishkit.social_followers
        scan_status:
          type: object
          description: Status of the most recent scan found.
          properties:
            last_processed:
              type: string
              description: Timestamp of when the submission was processed.
              example: Wed, 26 Oct 2022 16:04:51 GMT
            scan_complete:
              type: boolean
              description: For internal use.
            status_code:
              type: integer
              description: Status code that the crawler received when loading the
                submitted URL.
            submission_id:
              type: integer
              description: ID of the most recent submission.
        screenshot_download_signature:
          type: string
          description: For internal use.
        screenshot_path:
          type: string
          description: For internal use.
        url:
          type: string
          description: URL that was submitted.
          example: https://www.cloudflare.com
    phishing-url-info_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/phishing-url-info'
    phishing-url-submit:
      properties:
        excluded_urls:
          type: array
          description: URLs that were excluded from scanning because their domain
            is in our no-scan list.
          items:
            type: object
            properties:
              url:
                type: string
                description: URL that was excluded.
                example: https://developers.cloudflare.com
        skipped_urls:
          type: array
          description: URLs that were skipped because the same URL is currently being
            scanned
          items:
            type: object
            properties:
              url:
                type: string
                description: URL that was skipped.
                example: https://www.cloudflare.com/developer-week/
              url_id:
                type: integer
                description: ID of the submission of that URL that is currently scanning.
                example: 2
        submitted_urls:
          type: array
          description: URLs that were successfully submitted for scanning.
          items:
            type: object
            properties:
              url:
                type: string
                description: URL that was submitted.
                example: https://www.cloudflare.com
              url_id:
                type: integer
                description: ID assigned to this URL submission. Used to retrieve
                  scanning results.
                example: 1
    phishing-url-submit_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/phishing-url-submit'
    plan_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/schemas-rate-plan'
    platform:
      type: string
      enum:
      - windows
      - mac
      - linux
      - android
      - ios
      example: windows
    playback:
      type: object
      readOnly: true
      properties:
        dash:
          type: string
          description: DASH Media Presentation Description for the video.
          example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.mpd
          readOnly: true
        hls:
          type: string
          description: The HLS manifest for the video.
          example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/manifest/video.m3u8
          readOnly: true
    policies:
      type: array
      description: List of access policies assigned to the token.
      items:
        $ref: '#/components/schemas/access-policy'
    policies_components-schemas-description:
      type: string
      description: Optional description for the Notification policy.
      example: Something describing the policy.
    policies_components-schemas-enabled:
      type: boolean
      description: Whether or not the Notification policy is enabled.
      default: true
      example: true
    policies_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/components-schemas-uuid'
    policies_components-schemas-id_response-2:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/uuid'
    policies_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    policies_components-schemas-name:
      type: string
      description: The name of the Access policy.
      example: Allow devs
    policies_components-schemas-name-2:
      type: string
      description: Name of the policy.
      example: SSL Notification Event Policy
    policies_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/schemas-policies'
    policies_components-schemas-response_collection-2:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/components-schemas-policies'
    policies_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/schemas-policies'
    policies_components-schemas-single_response-2:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/components-schemas-policies'
    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)'
    policy_check_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              app_state:
                type: object
                properties:
                  app_uid:
                    $ref: '#/components/schemas/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/uuid'
                  version:
                    type: integer
    policy_with_permission_groups:
      title: policy_with_permission_groups
      required:
      - id
      - effect
      - resources
      - permission_groups
      properties:
        effect:
          $ref: '#/components/schemas/effect'
        id:
          $ref: '#/components/schemas/Cloudflare Client API_identifier'
        permission_groups:
          $ref: '#/components/schemas/permission_groups'
        resources:
          $ref: '#/components/schemas/resources'
    polish:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - polish
            example: polish
          value:
            $ref: '#/components/schemas/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.'
    polish_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "off"
      - lossless
      - lossy
      default: "off"
    pool:
      type: object
      properties:
        check_regions:
          $ref: '#/components/schemas/check_regions'
        created_on:
          $ref: '#/components/schemas/timestamp'
        description:
          $ref: '#/components/schemas/pool_components-schemas-description'
        disabled_at:
          $ref: '#/components/schemas/schemas-disabled_at'
        enabled:
          $ref: '#/components/schemas/pool_components-schemas-enabled'
        id:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
        latitude:
          $ref: '#/components/schemas/latitude'
        load_shedding:
          $ref: '#/components/schemas/load_shedding'
        longitude:
          $ref: '#/components/schemas/longitude'
        minimum_origins:
          $ref: '#/components/schemas/minimum_origins'
        modified_on:
          $ref: '#/components/schemas/timestamp'
        monitor:
          $ref: '#/components/schemas/schemas-monitor'
        name:
          $ref: '#/components/schemas/pool_components-schemas-name'
        notification_email:
          $ref: '#/components/schemas/notification_email'
        notification_filter:
          $ref: '#/components/schemas/notification_filter'
        origin_steering:
          $ref: '#/components/schemas/origin_steering'
        origins:
          $ref: '#/components/schemas/origins'
    pool_components-schemas-description:
      type: string
      description: A human-readable description of the pool.
      example: Primary data center - Provider XYZ
    pool_components-schemas-enabled:
      type: boolean
      description: Whether to enable (the default) or disable this pool. Disabled
        pools will not receive traffic and are excluded from health checks. Disabling
        a pool will cause any load balancers using it to failover to the next pool
        (if any).
      default: true
      example: false
    pool_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/pool_components-schemas-identifier'
    pool_components-schemas-identifier:
      example: 17b5962d775c646f3f9725cbc7a53df4
    pool_components-schemas-name:
      type: string
      description: A short name (tag) for the pool. Only alphanumeric characters,
        hyphens, and underscores are allowed.
      example: primary-dc-1
    pool_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/pool'
    pool_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/pool'
    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
    popularity_rank:
      type: integer
      description: Global Cloudflare 100k ranking for the last 30 days, if available
        for the hostname. The top ranked domain is 1, the lowest ranked domain is
        100,000.
    port:
      type: number
      description: DNS port of primary or secondary nameserver, depending on what
        zone this peer is linked to.
      example: 53
    position:
      type: string
      description: 'The location of the image. Valid positions are: `upperRight`,
        `upperLeft`, `lowerLeft`, `lowerRight`, and `center`. Note that `center` ignores
        the `padding` parameter.'
      default: upperRight
      example: center
      readOnly: true
    precedence:
      type: integer
      description: The order of execution for this policy. Must be unique for each
        policy.
    predefined_entry:
      type: object
      title: Predefined entry
      description: A predefined entry that matches a profile
      properties:
        enabled:
          type: boolean
          description: Whether the entry is enabled or not.
          example: true
        id:
          $ref: '#/components/schemas/entry_id'
        name:
          type: string
          description: The name of the entry.
          example: Credit card (Visa)
        profile_id:
          description: ID of the parent profile
    predefined_profile:
      type: object
      title: Predefined profile
      properties:
        entries:
          type: array
          description: The entries for this profile.
          items:
            $ref: '#/components/schemas/predefined_entry'
        id:
          $ref: '#/components/schemas/profile_id'
        name:
          type: string
          description: The name of the profile.
          example: Generic CVV Card Number
        type:
          type: string
          description: The type of the profile.
          enum:
          - predefined
          example: predefined
    predefined_profile_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            allOf:
            - $ref: '#/components/schemas/predefined_profile'
    prefetch_preload:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - prefetch_preload
            example: prefetch_preload
          value:
            $ref: '#/components/schemas/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"
    prefetch_preload_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    prefix:
      type: string
      description: IP Prefix in Classless Inter-Domain Routing format.
      example: 192.0.2.0/24
    preview:
      type: string
      format: uri
      description: The video's preview page URI. This field is omitted until encoding
        is complete.
      example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/watch
      readOnly: true
    preview_id:
      example: f1aba936b94213e5b8dca0c0dbf1f9cc
    preview_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              pools:
                type: object
                example:
                  abwlnp5jbqn45ecgxd03erbgtxtqai0d: WNAM Datacenter
                  ve8h9lrcip5n5bbga9yqmdws28ay5d0l: EEU Datacenter
              preview_id:
                $ref: '#/components/schemas/monitor_components-schemas-identifier'
    preview_result:
      type: object
      description: Resulting health data from a preview operation.
      example:
        abwlnp5jbqn45ecgxd03erbgtxtqai0d:
          healthy: true
          origins:
          - originone.example.com.:
              $ref: '#/components/schemas/origin_health_data/example'
    preview_result_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - $ref: '#/components/schemas/preview_result'
    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
    price:
      type: number
      description: The price of the subscription that will be billed, in US dollars.
      example: 20
      readOnly: true
    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
    privacy:
      type: boolean
      description: Privacy option controls redacting WHOIS information.
      example: true
    privacy_pass:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - privacy_pass
            example: privacy_pass
          value:
            $ref: '#/components/schemas/privacy_pass_value'
      title: Privacy Pass
      description: Privacy Pass is a browser extension developed by the Privacy Pass
        Team to improve the browsing experience for your visitors. Enabling Privacy
        Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).
    privacy_pass_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "on"
    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-----
    probe_zone:
      type: string
      description: Assign this monitor to emulate the specified zone while probing.
        This parameter is only valid for HTTP and HTTPS monitors.
      example: example.com
    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
    profile_id:
      allOf:
      - $ref: '#/components/schemas/uuid'
      description: The ID for this profile
      example: 384e129d-25bd-403c-8019-bc19eb7a8a5f
    profiles:
      anyOf:
      - $ref: '#/components/schemas/predefined_profile'
      - $ref: '#/components/schemas/custom_profile'
    profiles_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/profiles'
    project-patch:
      example:
        deployment_configs:
          production:
            compatibility_date: "2022-01-01"
            compatibility_flags:
            - url_standard
            env_vars:
              BUILD_VERSION:
                value: "3.3"
              delete_this_env_var: null
    project-response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
    project_name:
      type: string
      description: Name of the project.
      example: this-is-my-project-01
      pattern: ^[a-z0-9][a-z0-9-]*$
    projects:
      type: object
      properties:
        build_config:
          $ref: '#/components/schemas/build_config'
        canonical_deployment:
          oneOf:
          - nullable: true
          - $ref: '#/components/schemas/deployments'
          description: Most recent deployment to the repo.
          readOnly: true
        created_on:
          type: string
          format: date-time
          description: When the project was created.
          example: "2017-01-01T00:00:00Z"
          readOnly: true
        deployment_configs:
          $ref: '#/components/schemas/deployment_configs'
        domains:
          type: array
          description: A list of associated custom domains for the project.
          example:
          - customdomain.com
          - customdomain.org
          readOnly: true
          items: {}
        id:
          type: string
          description: Id of the project.
          example: 7b162ea7-7367-4d67-bcde-1160995d5
          readOnly: true
        latest_deployment:
          oneOf:
          - nullable: true
          - $ref: '#/components/schemas/deployments'
          description: Most recent deployment to the repo.
          readOnly: true
        name:
          type: string
          description: Name of the project.
          example: NextJS Blog
        production_branch:
          type: string
          description: Production branch of the project. Used to identify production
            deployments.
          example: main
        source:
          readOnly: true
        subdomain:
          type: string
          description: The Cloudflare subdomain associated with the project.
          example: helloworld.pages.dev
          readOnly: true
    projects-response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result_info:
            type: object
            properties:
              count:
                example: 1
              page:
                example: 1
              per_page:
                example: 100
              total_count:
                example: 1
      - properties:
          result:
            type: array
            items:
              type: object
    properties-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
    properties-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}$
    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
    provider_name:
      type: string
      description: The name of provider. Usually cloudflare.
      example: Cloudflare
    proxied:
      type: boolean
      description: Whether the record is receiving the performance and security benefits
        of Cloudflare.
      example: false
    proxy-endpoints:
      type: object
      properties:
        created_at:
          $ref: '#/components/schemas/timestamp'
        id:
          $ref: '#/components/schemas/proxy-endpoints_components-schemas-uuid'
        ips:
          $ref: '#/components/schemas/components-schemas-ips'
        name:
          $ref: '#/components/schemas/proxy-endpoints_components-schemas-name'
        subdomain:
          $ref: '#/components/schemas/schemas-subdomain'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    proxy-endpoints_components-schemas-empty_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    proxy-endpoints_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    proxy-endpoints_components-schemas-name:
      type: string
      description: The name of the Proxy Endpoint.
      example: Devops team
    proxy-endpoints_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/proxy-endpoints'
    proxy-endpoints_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/proxy-endpoints'
    proxy-endpoints_components-schemas-uuid:
      example: ed35569b41ce4d1facfe683550f54086
    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"
    proxy_read_timeout:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - proxy_read_timeout
            example: proxy_read_timeout
          value:
            $ref: '#/components/schemas/proxy_read_timeout_value'
      title: Proxy Read Timeout
      description: Maximum time between two read operations from origin.
    proxy_read_timeout_value:
      type: number
      description: |-
        Value of the zone setting.
        Notes: Value must be between 1 and 6000
      default: 100
    pseudo_ipv4:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: Value of the Pseudo IPv4 setting.
            enum:
            - pseudo_ipv4
            default: pseudo_ipv4
          value:
            $ref: '#/components/schemas/pseudo_ipv4_value'
      title: Pseudo IPv4 Value
      description: The value set for the Pseudo IPv4 setting.
    pseudo_ipv4_value:
      type: string
      description: Value of the Pseudo IPv4 setting.
      enum:
      - "off"
      - add_header
      - overwrite_header
      default: "off"
    psk:
      type: string
      description: A randomly generated or provided string for use in the IPsec tunnel.
      example: O3bwKSjnaoCxDoUxjcq4Rk8ZKkezQUiy
    psk_generation_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              ipsec_tunnel_id:
                $ref: '#/components/schemas/common_components-schemas-identifier'
              psk:
                $ref: '#/components/schemas/psk'
              psk_metadata:
                $ref: '#/components/schemas/psk_metadata'
    psk_metadata:
      type: object
      description: The PSK metadata that includes when the PSK was generated.
      properties:
        last_generated_on:
          $ref: '#/components/schemas/common_components-schemas-modified_on'
    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
    purge_by_cache_tags_or_hosts_or_prefixes:
      properties:
        hosts:
          type: array
          description: Any assets at URLs with a host that matches one of the provided
            values will be purged from the Cloudflare cache.
          example:
          - www.example.com
          - images.example.com
          maxLength: 30
          items:
            type: string
        prefixes:
          type: array
          description: Any assets at URLs that match the prefix will be purged from
            the Cloudflare cache. For example, a.com/b will purge a.com/b/c/d.png
            but not a.com/bc.png. The prefixes a.com/b and a.com/b/c are redundant.
          example:
          - www.example.com/foo
          - images.example.com/bar/baz
          maxLength: 30
          items:
            type: string
        tags:
          type: array
          description: Any assets served with a Cache-Tag header that matches one
            of the provided values will be purged from the Cloudflare cache.
          example:
          - some-tag
          - another-tag
          maxLength: 30
          items:
            type: string
    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.
    purpose_justification_required:
      type: boolean
      description: Require users to enter a justification when they log in to the
        application.
      default: false
      example: true
    query:
      type: object
      description: For specifying result metrics.
      properties:
        dimensions:
          type: array
          description: Can be used to break down the data by given attributes.
          default: '[]'
          items:
            type: string
            description: For drilling down on metrics.
        filters:
          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     ."
          default: '""'
        limit:
          type: integer
          description: Limit number of returned metrics.
          default: 10000
        metrics:
          type: array
          description: One or more metrics to compute.
          items:
            type: string
            description: A quantitative measurement of KV usage.
        since:
          type: string
          format: date-time
          description: Start of time interval to query, defaults to 6 hours before
            request received.
          default: <6 hours ago>
          example: "2019-01-02T02:20:00Z"
        sort:
          type: array
          description: Array of dimensions or metrics to sort by, each dimension/metric
            may be prefixed by - (descending) or + (ascending).
          default: '[]'
          items: {}
        until:
          type: string
          format: date-time
          description: End of time interval to query, defaults to current time.
          default: <now>
          example: "2019-01-02T03:20:00Z"
    query_event:
      type: object
      required:
      - name
      - event_start_time
      - event_end_time
      properties:
        custom_page_html:
          $ref: '#/components/schemas/event_custom_page_html'
        description:
          $ref: '#/components/schemas/event_description'
        disable_session_renewal:
          $ref: '#/components/schemas/event_disable_session_renewal'
        event_end_time:
          $ref: '#/components/schemas/event_end_time'
        event_start_time:
          $ref: '#/components/schemas/event_start_time'
        name:
          $ref: '#/components/schemas/event_name'
        new_users_per_minute:
          $ref: '#/components/schemas/event_new_users_per_minute'
        prequeue_start_time:
          $ref: '#/components/schemas/event_prequeue_start_time'
        queueing_method:
          $ref: '#/components/schemas/event_queueing_method'
        session_duration:
          $ref: '#/components/schemas/event_session_duration'
        shuffle_at_event_start:
          $ref: '#/components/schemas/event_shuffle_at_event_start'
        suspended:
          $ref: '#/components/schemas/event_suspended'
        total_active_users:
          $ref: '#/components/schemas/event_total_active_users'
    query_healthcheck:
      type: object
      required:
      - name
      - address
      properties:
        address:
          $ref: '#/components/schemas/schemas-address'
        check_regions:
          $ref: '#/components/schemas/schemas-check_regions'
        consecutive_fails:
          $ref: '#/components/schemas/consecutive_fails'
        consecutive_successes:
          $ref: '#/components/schemas/consecutive_successes'
        description:
          $ref: '#/components/schemas/healthchecks_components-schemas-description'
        http_config:
          $ref: '#/components/schemas/http_config'
        interval:
          $ref: '#/components/schemas/components-schemas-interval'
        name:
          $ref: '#/components/schemas/healthchecks_components-schemas-name'
        retries:
          $ref: '#/components/schemas/retries'
        suspended:
          $ref: '#/components/schemas/suspended'
        tcp_config:
          $ref: '#/components/schemas/tcp_config'
        timeout:
          $ref: '#/components/schemas/schemas-timeout'
        type:
          $ref: '#/components/schemas/healthchecks_components-schemas-type'
    query_preview:
      type: object
      required:
      - custom_html
      properties:
        custom_html:
          $ref: '#/components/schemas/custom_page_html'
    query_response:
      type: object
      description: The exact parameters/timestamps the analytics service used to return
        data.
      readOnly: true
      properties:
        since:
          $ref: '#/components/schemas/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/until'
    query_waitingroom:
      type: object
      required:
      - name
      - host
      - new_users_per_minute
      - total_active_users
      properties:
        cookie_attributes:
          $ref: '#/components/schemas/cookie_attributes'
        custom_page_html:
          $ref: '#/components/schemas/custom_page_html'
        default_template_language:
          $ref: '#/components/schemas/default_template_language'
        description:
          $ref: '#/components/schemas/waitingroom_components-schemas-description'
        disable_session_renewal:
          $ref: '#/components/schemas/disable_session_renewal'
        host:
          $ref: '#/components/schemas/components-schemas-host'
        json_response_enabled:
          $ref: '#/components/schemas/json_response_enabled'
        name:
          $ref: '#/components/schemas/waitingroom_components-schemas-name'
        new_users_per_minute:
          $ref: '#/components/schemas/new_users_per_minute'
        path:
          $ref: '#/components/schemas/schemas-path'
        queue_all:
          $ref: '#/components/schemas/queue_all'
        queueing_method:
          $ref: '#/components/schemas/queueing_method'
        session_duration:
          $ref: '#/components/schemas/schemas-session_duration'
        suspended:
          $ref: '#/components/schemas/schemas-suspended'
        total_active_users:
          $ref: '#/components/schemas/total_active_users'
    queue:
      type: object
      properties:
        consumers:
          readOnly: true
        consumers_total_count:
          readOnly: true
        created_on:
          readOnly: true
        modified_on:
          readOnly: true
        producers:
          readOnly: true
        producers_total_count:
          readOnly: true
        queue_id:
          readOnly: true
        queue_name:
          $ref: '#/components/schemas/queues_components-schemas-name'
    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
    queue_created:
      type: object
      properties:
        created_on:
          readOnly: true
        modified_on:
          readOnly: true
        queue_id:
          readOnly: true
        queue_name:
          $ref: '#/components/schemas/queues_components-schemas-name'
    queue_updated:
      type: object
      properties:
        created_on:
          readOnly: true
        modified_on:
          readOnly: true
        queue_id:
          readOnly: true
        queue_name:
          $ref: '#/components/schemas/renamed_name'
    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
    queues_components-schemas-name:
      type: string
      example: example-queue
    quota:
      type: object
      properties:
        allocated:
          type: integer
          description: Quantity Allocated.
        used:
          type: integer
          description: Quantity Used.
    r2-single-bucket-operation-response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
    railgun:
      type: object
      required:
      - id
      - name
      - status
      - enabled
      - zones_connected
      - build
      - version
      - revision
      - activation_key
      - activated_on
      - created_on
      - modified_on
      properties:
        activated_on:
          $ref: '#/components/schemas/activated_on'
        activation_key:
          $ref: '#/components/schemas/activation_key'
        build:
          $ref: '#/components/schemas/build'
        created_on:
          $ref: '#/components/schemas/railgun_components-schemas-created_on'
        enabled:
          $ref: '#/components/schemas/railgun_components-schemas-enabled'
        id:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
        modified_on:
          $ref: '#/components/schemas/railgun_components-schemas-modified_on'
        name:
          $ref: '#/components/schemas/railgun_components-schemas-name'
        revision:
          $ref: '#/components/schemas/revision'
        status:
          $ref: '#/components/schemas/railgun_components-schemas-status'
        upgrade_info:
          $ref: '#/components/schemas/upgrade_info'
        version:
          $ref: '#/components/schemas/railgun_components-schemas-version'
        zones_connected:
          $ref: '#/components/schemas/zones_connected'
    railgun_components-schemas-created_on:
      type: string
      format: date-time
      description: When the Railgun was created.
      example: "2014-01-01T05:20:00Z"
      readOnly: true
    railgun_components-schemas-enabled:
      type: boolean
      description: Flag to determine if the Railgun is accepting connections.
      default: false
      example: true
    railgun_components-schemas-identifier:
      type: string
      description: Railgun identifier tag.
      example: e928d310693a83094309acf9ead50448
      readOnly: true
      maxLength: 32
    railgun_components-schemas-identifier-2:
      type: string
      description: Railgun connection identifier tag.
      example: e928d310693a83094309acf9ead50448
      readOnly: true
      maxLength: 32
    railgun_components-schemas-modified_on:
      type: string
      format: date-time
      description: When the Railgun was last modified.
      example: "2014-01-01T05:20:00Z"
      readOnly: true
    railgun_components-schemas-name:
      type: string
      description: Readable identifier of the Railgun.
      example: My Railgun.
      maxLength: 160
    railgun_components-schemas-status:
      type: string
      description: Status of the Railgun.
      enum:
      - initializing
      - active
      example: active
      readOnly: true
    railgun_components-schemas-version:
      type: string
      description: The version of the Railgun receiver.
      example: "2.1"
      readOnly: true
    railgun_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/railgun'
    railgun_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    railgun_response_single_id:
      allOf:
      - $ref: '#/components/schemas/railgun_response_single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/railgun_components-schemas-identifier'
    random_steering:
      type: object
      description: Configures pool weights for random steering. When steering_policy
        is 'random', a random pool is selected with probability proportional to these
        pool weights.
      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
    rate-limits:
      allOf:
      - $ref: '#/components/schemas/components-schemas-ratelimit'
      type: object
    rate-limits_components-schemas-id:
      type: string
      description: The unique identifier of the rate limit.
      example: 372e67954025e0ba6aaa6d586b9e0b59
      readOnly: true
      maxLength: 32
    rate-plan:
      type: object
      properties:
        components:
          $ref: '#/components/schemas/schemas-component_values'
        currency:
          $ref: '#/components/schemas/currency'
        duration:
          $ref: '#/components/schemas/duration'
        frequency:
          $ref: '#/components/schemas/schemas-frequency'
        id:
          $ref: '#/components/schemas/rate-plan_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/rate-plan_components-schemas-name'
    rate-plan_components-schemas-identifier:
      type: string
      description: Plan identifier tag.
      example: free
      readOnly: true
    rate-plan_components-schemas-name:
      type: string
      description: The plan name.
      example: Free Plan
      readOnly: true
      maxLength: 80
    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
    ratelimit:
      type: number
      description: Ratelimit in queries per second per datacenter (applies to DNS
        queries sent to the origin nameservers configured on the cluster).
      example: 600
      nullable: true
      minimum: 100
      maximum: 1e+09
    ratelimit_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/rate-limits'
    ratelimit_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    ray_id:
      type: string
      description: The unique identifier for the request to Cloudflare.
      example: 187d944c61940c77
      maxLength: 16
    ray_identifier:
      type: string
      description: Ray identifier.
      example: 41ddf1740f67442d
      readOnly: true
      maxLength: 16
    ready:
      type: boolean
      description: Beta flag. Users can create a policy with a mechanism that is not
        ready, but we cannot guarantee successful delivery of notifications.
      example: true
    readyToStream:
      type: boolean
      description: Indicates whether the video is ready for viewing.
      example: true
      readOnly: true
    ref:
      type: string
      description: A short reference tag. Allows you to select related firewall rules.
      example: MIR-31
      maxLength: 50
    references_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            description: List of resources that reference a given monitor.
            example:
            - reference_type: referrer
              resource_id: 17b5962d775c646f3f9725cbc7a53df4
              resource_name: primary-dc-1
              resource_type: pool
            items:
              type: object
              properties:
                reference_type:
                  type: string
                  enum:
                  - '*'
                  - referral
                  - referrer
                resource_id:
                  type: string
                resource_name:
                  type: string
                resource_type:
                  type: string
    region_code:
      type: string
      description: 'A list of Cloudflare regions. 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, SAS: Southern Asia, SEAS: South East
        Asia, NEAS: North East Asia).'
      enum:
      - WNAM
      - ENAM
      - WEU
      - EEU
      - NSAM
      - SSAM
      - OC
      - ME
      - NAF
      - SAF
      - SAS
      - SEAS
      - NEAS
      example: WNAM
    region_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    region_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            description: A list of countries and subdivisions mapped to a region.
            example:
              iso_standard: Country and subdivision codes follow ISO 3166-1 alpha-2
                and ISO 3166-2
              regions:
              - countries:
                - country_code_a2: CA
                  country_name: Canada
                  country_subdivisions:
                  - subdivision_code_a2: AB
                    subdivision_name: Alberta
                  - subdivision_code_a2: BC
                    subdivision_name: British Columbia
                - country_code_a2: HT
                  country_name: Haiti
                - country_code_a2: MX
                  country_name: Mexico
                - country_code_a2: US
                  country_name: United States
                  country_subdivisions:
                  - subdivision_code_a2: AZ
                    subdivision_name: Arizona
                  - subdivision_code_a2: CA
                    subdivision_name: California
                  - subdivision_code_a2: CO
                    subdivision_name: Colorado
                  - subdivision_code_a2: HI
                    subdivision_name: Hawaii
                  - subdivision_code_a2: MN
                    subdivision_name: Minnesota
                  - subdivision_code_a2: MO
                    subdivision_name: Missouri
                  - subdivision_code_a2: NV
                    subdivision_name: Nevada
                  - subdivision_code_a2: OR
                    subdivision_name: Oregon
                  - subdivision_code_a2: TX
                    subdivision_name: Texas
                  - subdivision_code_a2: UT
                    subdivision_name: Utah
                  - subdivision_code_a2: WA
                    subdivision_name: Washington
                region_code: WNAM
    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
    registrant_contact:
      allOf:
      - $ref: '#/components/schemas/contacts'
      description: Shows contact information for domain registrant.
    registry_statuses:
      type: string
      description: A comma-separated list of registry status codes. A full list of
        status codes can be found at [EPP Status Codes](https://www.icann.org/resources/pages/epp-status-codes-2014-06-16-en).
      example: ok,serverTransferProhibited
    remote_config:
      type: boolean
      description: If `true`, the tunnel can be configured remotely from the Zero
        Trust dashboard. If `false`, the tunnel must be configured locally on the
        origin machine.
      example: true
    renamed_name:
      type: string
      example: renamed-example-queue
    request.ip:
      type: object
      description: Client IP restrictions.
      example:
        in:
        - 123.123.123.0/24
        - 2606:4700::/32
        not_in:
        - 123.123.123.100/24
        - 2606:4700:4700::/48
      properties:
        in:
          $ref: '#/components/schemas/cidr_list'
        not_in:
          $ref: '#/components/schemas/cidr_list'
    request_list:
      type: array
      items:
        $ref: '#/components/schemas/request_model'
    request_model:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/managed_headers_components-schemas-enabled'
        id:
          $ref: '#/components/schemas/managed_headers_components-schemas-id'
    request_type:
      type: string
      description: Signature type desired on certificate ("origin-rsa" (rsa), "origin-ecc"
        (ecdsa), or "keyless-certificate" (for Keyless SSL servers).
      enum:
      - origin-rsa
      - origin-ecc
      - keyless-certificate
      example: origin-rsa
    requested_validity:
      type: number
      description: The number of days for which the certificate should be valid.
      enum:
      - 7
      - 30
      - 90
      - 365
      - 730
      - 1095
      - 5475
      default: 5475
      example: 5475
    requests:
      type: integer
      description: The estimated number of requests covered by these calculations.
      readOnly: true
    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: 4.181364e+06
        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": 1.3496983e+07
            "301": 283
            "400": 187936
            "402": 1828
            "404": 1293
        uncached:
          type: integer
          description: Total number of requests served from the origin.
    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/rule_components-schemas-rule'
    requireSignedURLs:
      type: boolean
      description: Indicates whether the video can be a accessed using the UID. When
        set to `true`, a signed token must be generated with a signing key to view
        the video.
      default: false
      example: true
      readOnly: true
    resolves_to_ref:
      type: object
      properties:
        id:
          $ref: '#/components/schemas/stix_identifier'
        value:
          type: string
          description: IP address or domain name.
          example: 192.0.2.0
    resolves_to_refs:
      type: array
      description: Specifies a list of references to one or more IP addresses or domain
        names that the domain name currently resolves to.
      items:
        $ref: '#/components/schemas/resolves_to_ref'
    resource_reference:
      type: object
      description: A reference to a load balancer resource.
      properties:
        reference_type:
          type: string
          description: When listed as a reference, the type (direction) of the reference.
          enum:
          - referral
          - referrer
        references:
          type: array
          description: A list of references to (referrer) or from (referral) this
            resource.
          example:
          - reference_type: referrer
            resource_id: 699d98642c564d2e855e9661899b7252
            resource_name: www.example.com
            resource_type: load_balancer
          - reference_type: referral
            resource_id: f1aba936b94213e5b8dca0c0dbf1f9cc
            resource_name: Login page monitor
            resource_type: monitor
          items:
            type: object
            description: A reference to a load balancer resource.
        resource_id:
          example: 17b5962d775c646f3f9725cbc7a53df4
        resource_name:
          type: string
          description: The human-identifiable name of the resource.
          example: primary-dc-1
        resource_type:
          type: string
          description: The type of the resource.
          enum:
          - load_balancer
          - monitor
          - pool
          example: pool
    resources:
      type: object
      description: A list of resource names that the policy applies to.
      example:
        com.cloudflare.api.account.zone.22b1de5f1c0e4b3ea97bb1e963b06a43: '*'
        com.cloudflare.api.account.zone.eb78d65290b24279ba6f44721b3ea3c4: '*'
    response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/domain-history'
    response_buffering:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - response_buffering
            example: response_buffering
          value:
            $ref: '#/components/schemas/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"
    response_buffering_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              type: object
    response_create:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            allOf:
            - type: object
            - type: object
              properties:
                value:
                  $ref: '#/components/schemas/value'
    response_list:
      type: array
      items:
        $ref: '#/components/schemas/response_model'
    response_model:
      type: object
      properties:
        available:
          $ref: '#/components/schemas/available'
        enabled:
          $ref: '#/components/schemas/managed_headers_components-schemas-enabled'
        id:
          $ref: '#/components/schemas/managed_headers_components-schemas-id'
    response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    response_single_origin_dns:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              argo_smart_routing:
                $ref: '#/components/schemas/argo_smart_routing'
              created_on:
                $ref: '#/components/schemas/app_components-schemas-created'
              dns:
                $ref: '#/components/schemas/dns'
              edge_ips:
                $ref: '#/components/schemas/edge_ips'
              id:
                $ref: '#/components/schemas/app_id'
              ip_firewall:
                $ref: '#/components/schemas/ip_firewall'
              modified_on:
                $ref: '#/components/schemas/app_components-schemas-modified'
              origin_dns:
                $ref: '#/components/schemas/origin_dns'
              origin_port:
                $ref: '#/components/schemas/origin_port'
              protocol:
                $ref: '#/components/schemas/protocol'
              proxy_protocol:
                $ref: '#/components/schemas/proxy_protocol'
              tls:
                $ref: '#/components/schemas/tls'
              traffic_type:
                $ref: '#/components/schemas/traffic_type'
    response_single_segment:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            required:
            - id
            - status
            properties:
              expires_on:
                $ref: '#/components/schemas/expires_on'
              id:
                $ref: '#/components/schemas/components-schemas-identifier'
              not_before:
                $ref: '#/components/schemas/not_before'
              status:
                $ref: '#/components/schemas/status'
    response_single_value:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            $ref: '#/components/schemas/value'
    result:
      type: object
      required:
      - rows
      - data
      - totals
      properties:
        data:
          type: array
          nullable: true
          items:
            type: object
            required:
            - dimensions
            - metrics
            properties:
              dimensions:
                type: array
                description: Array of dimension values for this row.
                example:
                - name: NODATA
                items:
                  $ref: '#/components/schemas/dimension_value'
              metrics:
                type: array
                items: {}
        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:
          description: Maximum results for each metric.
        min:
          description: Minimum results for each metric.
        rows:
          type: number
          description: Total number of rows in the result.
          example: 100
          minimum: 0
        totals:
          description: Total results for metrics across all data.
    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
    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
    revision:
      type: string
      description: The revision of the Railgun receiver.
      example: "123"
      readOnly: true
    revoke_devices_request:
      type: array
      description: A list of device ids to revoke.
      maxLength: 200
      items:
        $ref: '#/components/schemas/uuid'
    revoked_at:
      type: string
      format: date-time
      description: When the device was revoked.
      example: "2017-06-14T00:00:00Z"
    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/waf_rewrite_action'
        challenge:
          example: block
        default:
          example: block
        disable:
          $ref: '#/components/schemas/waf_rewrite_action'
        simulate:
          example: disable
    risk_score:
      type: number
      description: Hostname risk score, which is a value between 0 (lowest risk) to
        1 (highest risk).
    risk_types:
      example: []
    rocket_loader:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - rocket_loader
            example: rocket_loader
          value:
            $ref: '#/components/schemas/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.
    rocket_loader_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    role:
      type: object
      required:
      - id
      - name
      - description
      - permissions
      properties:
        description:
          type: string
          description: Description of role's permissions.
          example: Administrative access to the entire Account
          readOnly: true
        id:
          $ref: '#/components/schemas/role_components-schemas-identifier'
        name:
          type: string
          description: Role name.
          example: Account Administrator
          readOnly: true
          maxLength: 120
        permissions:
          $ref: '#/components/schemas/permissions'
    role_components-schemas-identifier:
      type: string
      description: Role identifier tag.
      example: 3536bcfad5faccb999b47003c79917fb
      readOnly: true
      maxLength: 32
    roles:
      type: array
      description: List of role names for the user at the account.
      readOnly: true
      items:
        type: string
        example: Account Administrator
        maxLength: 120
    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
    route-no-id:
      required:
      - pattern
      properties:
        pattern:
          $ref: '#/components/schemas/pattern'
        script:
          $ref: '#/components/schemas/schemas-script_name'
    route-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/routes'
    route-response-single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/routes'
    route_add_single_request:
      type: object
      required:
      - prefix
      - nexthop
      - priority
      properties:
        description:
          $ref: '#/components/schemas/route_components-schemas-description'
        nexthop:
          $ref: '#/components/schemas/nexthop'
        prefix:
          $ref: '#/components/schemas/prefix'
        priority:
          $ref: '#/components/schemas/route_components-schemas-priority'
        scope:
          $ref: '#/components/schemas/schemas-scope'
        weight:
          $ref: '#/components/schemas/schemas-weight'
    route_components-schemas-created_on:
      type: string
      format: date-time
      description: When the route was created.
      example: "2017-06-14T00:00:00Z"
      readOnly: true
    route_components-schemas-description:
      type: string
      description: An optional human provided description of the static route.
      example: New route for new prefix 203.0.113.1
    route_components-schemas-identifier:
      type: string
      description: Route identifier tag.
      example: c4a7362d577a6c3019a474fd6f485821
      readOnly: true
      maxLength: 32
    route_components-schemas-modified_on:
      type: string
      format: date-time
      description: When the route was last modified.
      example: "2017-06-14T05:20:00Z"
      readOnly: true
    route_components-schemas-priority:
      type: integer
      description: Priority of the static route.
    route_deleted_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              deleted:
                type: boolean
                example: true
              deleted_route:
                type: object
    route_modified_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              modified:
                type: boolean
                example: true
              modified_route:
                type: object
    route_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/teamnet'
    route_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    route_single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              route:
                type: object
    route_update_many_request:
      type: object
      required:
      - routes
      properties:
        routes:
          type: array
          items:
            $ref: '#/components/schemas/route_update_single_request'
    route_update_request:
      allOf:
      - $ref: '#/components/schemas/route_add_single_request'
    route_update_single_request:
      allOf:
      - required:
        - id
        properties:
          id:
            $ref: '#/components/schemas/common_components-schemas-identifier'
      - $ref: '#/components/schemas/route_add_single_request'
    routes:
      type: object
      required:
      - id
      - pattern
      - script
      properties:
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        pattern:
          $ref: '#/components/schemas/pattern'
        script:
          $ref: '#/components/schemas/schemas-script_name'
    routes_collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              routes:
                type: array
                items:
                  $ref: '#/components/schemas/schemas-route'
    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/schemas-mode'
        configuration:
          $ref: '#/components/schemas/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/rule_components-schemas-identifier'
        mode:
          $ref: '#/components/schemas/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/notes'
    rule-settings:
      type: object
      description: Additional settings that modify the rule's action.
      properties:
        add_headers:
          type: object
          description: Add custom headers to allowed requests, in the form of key-value
            pairs. Keys are header names, pointing to an array with its header value(s).
          example:
            My-Next-Header:
            - foo
            - bar
            X-Custom-Header-Name:
            - somecustomvalue
        biso_admin_controls:
          type: object
          description: Configure how browser isolation behaves.
          properties:
            dcp:
              type: boolean
              description: Disable copy-paste.
              example: false
            dd:
              type: boolean
              description: Disable download.
              example: false
            dk:
              type: boolean
              description: Disable keyboard usage.
              example: false
            dp:
              type: boolean
              description: Disable printing.
              example: false
            du:
              type: boolean
              description: Disable upload.
              example: false
        block_page_enabled:
          type: boolean
          description: Enable the custom block page.
          example: true
        block_reason:
          type: string
          description: The text describing why this block occurred that will be displayed
            on the custom block page (if enabled).
          example: This website is a security risk
        check_session:
          type: object
          description: Configure how session check behaves.
          properties:
            duration:
              type: string
              description: Configure how fresh the session needs to be to be considered
                valid.
              example: 300s
            enforce:
              type: boolean
              description: Enable session enforcement for this fule.
              example: true
        insecure_disable_dnssec_validation:
          type: boolean
          description: INSECURE - disable DNSSEC validation (for allow actions).
          example: false
        ip_categories:
          type: boolean
          description: Include IPs in DNS resolver category blocks. By default categories
            only block on domain names.
          example: true
        l4override:
          type: object
          description: Send matching traffic to the supplied destination IP address
            and port.
          properties:
            ip:
              type: string
              description: IPv4 or IPv6 address.
              example: 1.1.1.1
            port:
              type: integer
              description: A port number to use for TCP/UDP overrides.
        override_host:
          type: string
          description: Override matching DNS queries with this.
          example: example.com
        override_ips:
          type: array
          description: Override matching DNS queries with this.
          example:
          - 1.1.1.1
          - 2.2.2.2
          items:
            type: string
            description: IPv4 or IPv6 address.
            example: 1.1.1.1
    rule_action:
      type: string
      description: The action to take when the expression matches.
      enum:
      - bypass_waiting_room
      example: bypass_waiting_room
    rule_collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/rule'
    rule_components-schemas-base:
      properties:
        description:
          $ref: '#/components/schemas/rule_components-schemas-description'
        group:
          type: object
          description: The rule group to which the current WAF rule belongs.
          readOnly: true
          properties:
            id:
              $ref: '#/components/schemas/group_components-schemas-identifier'
            name:
              $ref: '#/components/schemas/group_components-schemas-name'
        id:
          $ref: '#/components/schemas/rule_components-schemas-identifier-2'
        package_id:
          $ref: '#/components/schemas/package_components-schemas-identifier'
        priority:
          $ref: '#/components/schemas/rule_components-schemas-priority'
    rule_components-schemas-base-2:
      allOf:
      - $ref: '#/components/schemas/rule_components-schemas-base'
    rule_components-schemas-description:
      type: string
      description: The public description of the WAF rule.
      example: SQL injection prevention for SELECT statements
      readOnly: true
    rule_components-schemas-identifier:
      type: string
      description: The unique identifier of the IP Access rule.
      example: 92f17202ed8bd63d69a66b86a49a8f6b
      readOnly: true
      maxLength: 32
    rule_components-schemas-identifier-2:
      type: string
      description: The unique identifier of the WAF rule.
      example: f939de3be84e66e757adcdcb87908023
      readOnly: true
      maxLength: 32
    rule_components-schemas-priority:
      type: string
      description: The order in which the individual WAF rule is executed within its
        rule group.
      readOnly: true
    rule_components-schemas-rule:
      oneOf:
      - $ref: '#/components/schemas/email_rule'
      - $ref: '#/components/schemas/domain_rule'
      - $ref: '#/components/schemas/everyone_rule'
      - $ref: '#/components/schemas/ip_rule'
      - $ref: '#/components/schemas/ip_list_rule'
      - $ref: '#/components/schemas/certificate_rule'
      - $ref: '#/components/schemas/access_group_rule'
      - $ref: '#/components/schemas/azure_group_rule'
      - $ref: '#/components/schemas/github_organization_rule'
      - $ref: '#/components/schemas/gsuite_group_rule'
      - $ref: '#/components/schemas/okta_group_rule'
      - $ref: '#/components/schemas/saml_group_rule'
      type: object
    rule_description:
      type: string
      description: The description of the rule.
      default: ""
      example: allow all traffic from 10.20.30.40
    rule_enabled:
      type: boolean
      description: When set to true, the rule is enabled.
      default: true
      example: true
    rule_expression:
      type: string
      description: Criteria defining when there is a match for the current rule.
      example: ip.src in {10.20.30.40}
    rule_group_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/schemas-group'
    rule_group_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    rule_id:
      type: string
      description: The ID of the rule.
      example: 25756b2dfe6e378a06b033b670413757
    rule_identifier:
      type: string
      description: Routing rule identifier.
      example: a7e6fb77503c41d8a7f3113c6918f10c
      readOnly: true
      maxLength: 32
    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
    rule_properties:
      type: object
      properties:
        actions:
          $ref: '#/components/schemas/actions'
        enabled:
          $ref: '#/components/schemas/rules_components-schemas-enabled'
        matchers:
          $ref: '#/components/schemas/matchers'
        name:
          $ref: '#/components/schemas/rules_components-schemas-name'
        priority:
          $ref: '#/components/schemas/components-schemas-priority'
        tag:
          $ref: '#/components/schemas/rule_identifier'
    rule_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/components-schemas-rule'
    rule_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    rule_result:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/rule_action'
        description:
          $ref: '#/components/schemas/rule_description'
        enabled:
          $ref: '#/components/schemas/rule_enabled'
        expression:
          $ref: '#/components/schemas/rule_expression'
        id:
          $ref: '#/components/schemas/rule_id'
        last_updated:
          $ref: '#/components/schemas/timestamp'
        version:
          $ref: '#/components/schemas/rule_version'
    rule_single_id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/rule_components-schemas-identifier'
    rule_single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/rule'
    rule_version:
      type: string
      description: The version of the rule.
      example: "1"
    rules:
      allOf:
      - $ref: '#/components/schemas/rule_properties'
      type: object
    rules_components-schemas-account_identifier:
      example: 6f91088a406011ed95aed352566e8d4c
    rules_components-schemas-action:
      type: string
      description: The action to perform when the rule matches.
      example: execute
      pattern: ^[a-z_]+$
    rules_components-schemas-action-2:
      type: string
      description: The action to preform when the associated traffic, identity, and
        device posture expressions are either absent or evaluate to 'true'.
      enum:
      - "on"
      - "off"
      - allow
      - block
      - scan
      - noscan
      - safesearch
      - ytrestricted
      - isolate
      - noisolate
      - override
      - l4_override
      example: allow
    rules_components-schemas-description:
      type: string
      description: An informative description of the rule.
      default: ""
      example: Execute the OWASP ruleset when the IP address is not 1.1.1.1
    rules_components-schemas-description-2:
      type: string
      description: The description of the Rule.
      example: Block the bad websites based on host name
    rules_components-schemas-empty_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    rules_components-schemas-enabled:
      type: boolean
      description: Routing rule status.
      enum:
      - true
      - false
      default: true
      example: true
    rules_components-schemas-enabled-2:
      type: boolean
      description: Whether the rule should be executed.
      default: "true"
      example: true
    rules_components-schemas-enabled-3:
      type: boolean
      description: Set if the rule is enabled.
      example: true
    rules_components-schemas-id:
      type: string
      description: The unique ID of the rule.
      example: 3a03d665bac047339bb530ecb439a90d
    rules_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    rules_components-schemas-name:
      type: string
      description: Routing rule name.
      example: Send to user@example.net rule.
      maxLength: 256
    rules_components-schemas-name-2:
      type: string
      description: The name of the Rule.
      example: block bad websites
    rules_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/rules_components-schemas-rules'
    rules_components-schemas-rule:
      type: object
      description: A rule object.
      properties:
        action:
          $ref: '#/components/schemas/rules_components-schemas-action'
        action_parameters:
          $ref: '#/components/schemas/action_parameters'
        categories:
          $ref: '#/components/schemas/categories'
        description:
          $ref: '#/components/schemas/rules_components-schemas-description'
        enabled:
          $ref: '#/components/schemas/rules_components-schemas-enabled-2'
        expression:
          $ref: '#/components/schemas/schemas-expression'
        id:
          $ref: '#/components/schemas/rules_components-schemas-id'
        last_updated:
          $ref: '#/components/schemas/schemas-last_updated'
        logging:
          $ref: '#/components/schemas/logging'
        ref:
          $ref: '#/components/schemas/components-schemas-ref'
        version:
          $ref: '#/components/schemas/schemas-version'
    rules_components-schemas-rules:
      type: object
      properties:
        action:
          $ref: '#/components/schemas/rules_components-schemas-action-2'
        created_at:
          $ref: '#/components/schemas/timestamp'
        deleted_at:
          $ref: '#/components/schemas/deleted_at'
        description:
          $ref: '#/components/schemas/rules_components-schemas-description-2'
        device_posture:
          $ref: '#/components/schemas/device_posture'
        enabled:
          $ref: '#/components/schemas/rules_components-schemas-enabled-3'
        filters:
          $ref: '#/components/schemas/schemas-filters'
        id:
          $ref: '#/components/schemas/rules_components-schemas-uuid'
        identity:
          $ref: '#/components/schemas/identity'
        name:
          $ref: '#/components/schemas/rules_components-schemas-name-2'
        precedence:
          $ref: '#/components/schemas/schemas-precedence'
        rule_settings:
          $ref: '#/components/schemas/rule-settings'
        traffic:
          $ref: '#/components/schemas/traffic'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    rules_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/rules_components-schemas-rules'
    rules_components-schemas-uuid:
      type: string
      description: API Resource UUID tag.
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      maxLength: 36
    rules_count:
      type: number
      description: The number of rules in the current rule group.
      default: 0
      example: 10
      readOnly: true
    rules_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/rules'
          result_info:
            type: object
            properties:
              count:
                example: 1
              page:
                example: 1
              per_page:
                example: 20
              total_count:
                example: 1
    ruleset:
      type: object
      description: A ruleset object.
      properties:
        description:
          $ref: '#/components/schemas/rulesets_components-schemas-description'
        id:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
        kind:
          $ref: '#/components/schemas/schemas-kind'
        last_updated:
          $ref: '#/components/schemas/last_updated'
        name:
          $ref: '#/components/schemas/rulesets_components-schemas-name'
        phase:
          $ref: '#/components/schemas/phase'
        rules:
          $ref: '#/components/schemas/components-schemas-rules'
        version:
          $ref: '#/components/schemas/version'
    ruleset_response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - type: object
        properties:
          result:
            $ref: '#/components/schemas/ruleset'
    ruleset_without_rules:
      type: object
      description: A ruleset object.
      properties:
        description:
          $ref: '#/components/schemas/rulesets_components-schemas-description'
        id:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
        kind:
          $ref: '#/components/schemas/schemas-kind'
        last_updated:
          $ref: '#/components/schemas/last_updated'
        name:
          $ref: '#/components/schemas/rulesets_components-schemas-name'
        phase:
          $ref: '#/components/schemas/phase'
        version:
          $ref: '#/components/schemas/version'
    rulesets_components-schemas-description:
      type: string
      description: An informative description of the ruleset.
      default: ""
      example: My ruleset to execute managed rulesets
    rulesets_components-schemas-id:
      type: string
      description: The unique ID of the ruleset.
      example: 2f2feab2026849078ba485f918791bdc
      pattern: ^[0-9a-f]{32}$
    rulesets_components-schemas-name:
      type: string
      description: The human-readable name of the ruleset.
      example: My ruleset
    rulesets_response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - type: object
        properties:
          result:
            type: array
            description: A list of rulesets. The returned information will not include
              the rules in each ruleset.
            items:
              $ref: '#/components/schemas/ruleset_without_rules'
    run_at:
      type: string
      format: date-time
      description: Timestamp of when the tunnel connection was started.
      example: "2009-11-10T23:00:00Z"
    saas_app:
      type: object
      properties:
        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/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
        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/timestamp'
    saas_props:
      type: object
      title: SaaS Application
      properties:
        allowed_idps:
          $ref: '#/components/schemas/allowed_idps'
        app_launcher_visible:
          $ref: '#/components/schemas/app_launcher_visible'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/auto_redirect_to_identity'
        logo_url:
          $ref: '#/components/schemas/logo_url'
        name:
          $ref: '#/components/schemas/apps_components-schemas-name'
        saas_app:
          $ref: '#/components/schemas/saas_app'
        type:
          type: string
          description: The application type.
          example: saas
    same_site_cookie_attribute:
      type: string
      description: Sets the SameSite cookie setting, which provides increased security
        against CSRF attacks.
      example: strict
    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
    scale:
      type: number
      description: The size of the image relative to the overall size of the video.
        This parameter will adapt to horizontal and vertical videos automatically.
        `0.0` indicates no scaling (use the size of the image as-is), and `1.0 `fills
        the entire video.
      default: 0.15
      example: 0.1
      readOnly: true
      minimum: 0
      maximum: 1
    schedule:
      type: string
      description: 'Polling frequency for the WARP client posture check. Default:
        `5m` (poll every five minutes). Minimum: `1m`.'
      example: 1h
    schema_response_discovery:
      allOf:
      - $ref: '#/components/schemas/default_response'
      - properties:
          result:
            type: object
            properties:
              schemas:
                type: array
                items:
                  $ref: '#/components/schemas/openapi'
              timestamp:
                type: string
    schema_response_with_thresholds:
      allOf:
      - $ref: '#/components/schemas/default_response'
      - properties:
          result:
            type: object
            properties:
              schemas:
                type: array
                items:
                  $ref: '#/components/schemas/openapiwiththresholds'
              timestamp:
                type: string
    schemas-access_seat:
      type: boolean
      description: True if the user has authenticated with Cloudflare Access.
      example: false
    schemas-account:
      allOf:
      - $ref: '#/components/schemas/account'
      readOnly: true
    schemas-account_identifier:
      example: 01a7362d577a6c3019a474fd6f485823
    schemas-action:
      type: object
      description: Actions pattern.
      required:
      - type
      - value
      properties:
        type:
          type: string
          description: Type of supported action.
          enum:
          - forward
          - worker
          example: forward
        value:
          type: array
          items:
            type: string
            description: Value for action.
            example: destinationaddress@example.net
            maxLength: 90
    schemas-action_parameters:
      oneOf:
      - $ref: '#/components/schemas/action_parameters_rewrite'
      type: object
      description: The parameters configuring the action.
    schemas-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/route'
    schemas-address:
      type: string
      description: The hostname or IP address of the origin server to run health checks
        on.
      example: www.example.com
    schemas-advertised:
      type: boolean
      description: Enablement of prefix advertisement to the Internet.
      example: true
    schemas-alert_type:
      type: string
      description: Type of notification that has been dispatched.
      example: universal_ssl_event_type
    schemas-allowed:
      type: boolean
      description: The result of the authentication event.
      default: false
    schemas-app_id:
      example: 699d98642c564d2e855e9661899b7252
    schemas-app_launcher_visible:
      type: boolean
      description: Displays the application in the App Launcher.
      example: true
    schemas-application:
      type: object
      description: Application that the hostname belongs to.
      properties:
        id:
          type: integer
        name:
          type: string
          example: CLOUDFLARE
    schemas-apps:
      anyOf:
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/self_hosted_props'
        type: object
        title: Self Hosted Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/saas_props'
        type: object
        title: SaaS Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/ssh_props'
        type: object
        title: Browser SSH Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/vnc_props'
        type: object
        title: Browser VNC Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/app_launcher_props'
        type: object
        title: App Launcher Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/warp_props'
        type: object
        title: Device Enrollment Permissions Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/biso_props'
        type: object
        title: Browser Isolation Permissions Application
      - allOf:
        - $ref: '#/components/schemas/basic_app_response_props'
        - $ref: '#/components/schemas/schemas-bookmark_props'
        type: object
        title: Bookmark application
      type: object
    schemas-asn:
      type: string
      description: AS number associated with the node object.
    schemas-aud:
      type: string
      description: Audience tag.
      example: 737646a56ab1df6ec9bddc7e5ca84eaf3b0768850f3ffb5d74f1534911fe3893
      readOnly: true
      maxLength: 64
    schemas-automatic_platform_optimization:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - automatic_platform_optimization
            example: automatic_platform_optimization
          value:
            $ref: '#/components/schemas/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.'
    schemas-available:
      type: boolean
      description: Shows if a domain is available for transferring into Cloudflare
        Registrar.
      example: false
    schemas-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:
          anyOf:
          - type: string
          - type: number
          - type: object
          - type: array
            items: {}
          description: Current value of the zone setting.
          example: "on"
    schemas-bookmark_props:
      type: object
      title: Bookmark Application
      properties:
        app_launcher_visible:
          default: true
        domain:
          description: The URL or domain of the bookmark.
          example: https://mybookmark.com
        logo_url:
          $ref: '#/components/schemas/logo_url'
        name:
          $ref: '#/components/schemas/apps_components-schemas-name'
        type:
          type: string
          description: The application type.
          example: bookmark
    schemas-can_delete:
      type: boolean
      description: Controls whether the membership can be deleted via the API or not.
      example: true
    schemas-categories:
      type: object
      readOnly: true
      properties:
        beta:
          $ref: '#/components/schemas/beta'
        class:
          $ref: '#/components/schemas/class'
        description:
          $ref: '#/components/schemas/categories_components-schemas-description'
        id:
          $ref: '#/components/schemas/categories_components-schemas-id'
        name:
          $ref: '#/components/schemas/categories_components-schemas-name'
        subcategories:
          type: array
          description: All subcategories for this category.
          items:
            $ref: '#/components/schemas/subcategory'
    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-----'
    schemas-certificate_authority:
      type: string
      description: The Certificate Authority that Total TLS certificates will be issued
        through.
      enum:
      - google
      - lets_encrypt
      example: google
    schemas-certificate_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/certificates'
    schemas-certificate_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    schemas-certificateObject:
      properties:
        certificate:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate'
        expires_on:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-expires_on'
        id:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier'
        issuer:
          $ref: '#/components/schemas/issuer'
        serial_number:
          $ref: '#/components/schemas/serial_number'
        signature:
          $ref: '#/components/schemas/signature'
        status:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-status'
        uploaded_on:
          $ref: '#/components/schemas/components-schemas-uploaded_on'
    schemas-certificates:
      type: object
      properties:
        associated_hostnames:
          $ref: '#/components/schemas/associated_hostnames'
        created_at:
          $ref: '#/components/schemas/timestamp'
        expires_on:
          $ref: '#/components/schemas/timestamp'
        fingerprint:
          $ref: '#/components/schemas/fingerprint'
        id:
          description: The ID of the application that will use this certificate.
        name:
          $ref: '#/components/schemas/certificates_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    schemas-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
    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
    schemas-collection_invite_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/schemas-invite'
    schemas-collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              properties:
                additional_information:
                  $ref: '#/components/schemas/additional_information'
                application:
                  $ref: '#/components/schemas/schemas-application'
                content_categories:
                  $ref: '#/components/schemas/content_categories'
                domain:
                  $ref: '#/components/schemas/schemas-domain_name'
                popularity_rank:
                  $ref: '#/components/schemas/popularity_rank'
                risk_score:
                  $ref: '#/components/schemas/risk_score'
                risk_types:
                  $ref: '#/components/schemas/risk_types'
    schemas-colo_name:
      type: string
      description: The Cloudflare data center used for this connection.
      example: DFW
    schemas-comment:
      type: string
      description: Optional remark describing the virtual network.
      example: Staging VPC for data science
    schemas-component_values:
      type: array
      description: Array of available components values for the plan.
      items:
        $ref: '#/components/schemas/component-value'
    schemas-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/).
    schemas-configuration:
      oneOf:
      - $ref: '#/components/schemas/ip_configuration'
      - $ref: '#/components/schemas/ipv6_configuration'
      - $ref: '#/components/schemas/cidr_configuration'
      - $ref: '#/components/schemas/asn_configuration'
      - $ref: '#/components/schemas/country_configuration'
      type: object
      description: The rule configuration.
    schemas-connection:
      type: object
      required:
      - id
      - zone
      - enabled
      properties:
        created_on:
          $ref: '#/components/schemas/connection_components-schemas-created_on'
        enabled:
          $ref: '#/components/schemas/connection_components-schemas-enabled'
        id:
          $ref: '#/components/schemas/connection_components-schemas-identifier'
        modified_on:
          $ref: '#/components/schemas/connection_components-schemas-modified_on'
        zone:
          $ref: '#/components/schemas/connection_components-schemas-zone'
    schemas-count:
      type: number
      description: Total results returned based on your search parameters.
      example: 1
    schemas-create:
      type: object
      required:
      - name
      - account
      properties:
        account:
          type: object
          description: Account in which the zone was created.
          properties:
            id:
              $ref: '#/components/schemas/common_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/properties-name'
        type:
          $ref: '#/components/schemas/components-schemas-type'
    schemas-created:
      type: string
      format: date-time
      description: The date and time the media item was created.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    schemas-created_at:
      type: string
      format: date-time
      description: The time when the certificate was created.
      example: "2100-01-01T05:20:00Z"
      readOnly: true
    schemas-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
    schemas-cursor:
      type: string
      description: Opaque token indicating the position from which to continue when
        requesting the next set of records. A valid value for the cursor can be obtained
        from the cursors object in the result_info structure.
      example: AAAAANuhDN7SjacTnSVsDu3WW1Lvst6dxJGTjRY5BhxPXdf6L6uTcpd_NVtjhn11OUYRsVEykxoUwF-JQU4dn6QylZSKTOJuG0indrdn_MlHpMRtsxgXjs-RPdHYIVm3odE_uvEQ_dTQGFm8oikZMohns34DLBgrQpc
    schemas-default:
      type: boolean
      description: Whether the policy is the default policy for an account.
      example: false
    schemas-deleted:
      type: boolean
      description: True if the device was deleted.
      example: true
    schemas-deleted_at:
      type: string
      format: date-time
      description: Timestamp of when the tunnel was deleted. If `null`, the tunnel
        has not been deleted.
      example: "2009-11-10T23:00:00Z"
      nullable: true
    schemas-deleted_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            example: {}
    schemas-description:
      type: string
      description: The billing item description.
      example: The billing item description
      readOnly: true
      maxLength: 255
    schemas-direct_upload_request:
      type: object
      properties:
        expiry:
          type: string
          format: date-time
          description: 'The date after which the upload will not be accepted. Minimum:
            Now + 2 minutes. Maximum: Now + 6 hours.'
          default: Now + 30 minutes
          example: "2021-01-02T02:20:00Z"
    schemas-direct_upload_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              id:
                $ref: '#/components/schemas/images_components-schemas-identifier'
              uploadURL:
                type: string
                description: The URL the unauthenticated upload can be performed to
                  using a single HTTP POST (multipart/form-data) request.
                example: https://upload.imagedelivery.net/e22e9e6b-c02b-42fd-c405-6c32af5fe623
    schemas-disabled_at:
      type: string
      format: date-time
      description: This field shows up only if the pool is disabled. This field is
        set with the time the pool was disabled at.
      readOnly: true
    schemas-dns-firewall:
      allOf:
      - $ref: '#/components/schemas/dns-firewall'
      type: object
    schemas-dns-record:
      type: object
      description: List of records needed to enable an Email Routing zone.
      properties:
        content:
          type: string
          description: DNS record content.
          example: 127.0.0.1
        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: 10
          minimum: 0
          maximum: 65535
        ttl:
          anyOf:
          - type: number
            example: 3600
            minimum: 60
            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: 3600
        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: A
          readOnly: true
    schemas-domain:
      type: string
      description: The domain and path that Access will secure.
      example: test.example.com/admin
    schemas-domain_identifier:
      type: string
      description: Domain identifier.
      example: ea95132c15732412d22c1476fa83f27a
      readOnly: true
      maxLength: 32
    schemas-domain_name:
      type: string
      example: cloudflare.com
    schemas-duration:
      type: integer
      description: The duration of the video in seconds. A value of `-1` means the
        duration is unknown. The duration becomes available after the upload and before
        the video is ready.
      readOnly: true
    schemas-email:
      type: string
      format: email
      description: The email address of the authenticating user.
      example: user@example.com
    schemas-empty_response:
      allOf:
      - properties:
          result:
            type: boolean
            enum:
            - true
            - false
            example: true
          success:
            type: boolean
            enum:
            - true
            - false
            example: true
    schemas-enabled:
      type: boolean
      description: Whether or not the Keyless SSL is on or off.
      example: false
      readOnly: true
    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/rule_components-schemas-rule'
    schemas-expected_codes:
      type: string
      description: The expected HTTP response codes or code ranges of the health check,
        comma-separated. This parameter is only valid for HTTP and HTTPS monitors.
      default: "200"
      example: 2xx
    schemas-expiration:
      type: string
      description: Sets the expiration time for a posture check result. If empty,
        the result remains valid until it is overwritten by new data from the WARP
        client.
      example: 1h
    schemas-expires_on:
      type: string
      format: date-time
      description: When the invite is no longer active.
      example: "2014-01-01T05:20:00Z"
      readOnly: true
    schemas-expression:
      type: string
      description: The expression defining which traffic will match the rule.
      example: ip.src ne 1.1.1.1
    schemas-features:
      type: array
      description: Features enabled for the Cloudflare Tunnel.
      items:
        type: string
        example: ha-origin
    schemas-filter-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              allOf:
              - $ref: '#/components/schemas/filter'
              - type: object
                required:
                - id
                - expression
                - paused
    schemas-filter-response-single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        required:
        - result
        properties:
          result:
            oneOf:
            - allOf:
              - $ref: '#/components/schemas/filter'
              - type: object
                required:
                - id
                - expression
                - paused
            - nullable: true
    schemas-filter_options:
      type: array
      description: 'Format of additional configuration options (filters) for the alert
        type. Data type of filters during policy creation: Array of strings.'
      example:
      - ComparisonOperator: ==
        Key: zones
        Optional: false
      - ComparisonOperator: '>='
        Key: slo
        Optional: true
      items: {}
    schemas-filters:
      type: array
      description: The protocol or layer to evaluate the traffic, identity, and device
        posture expressions.
      example:
      - http
      items:
        type: string
        description: The protocol or layer to use.
        enum:
        - http
        - dns
        - l4
        example: http
    schemas-force_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/schemas-force_result'
    schemas-force_result:
      type: string
      description: When force_notify query parameter is set to true, the response
        is a simple string
      example: OK
    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
    schemas-gateway_seat:
      type: boolean
      description: True if the user has logged into the WARP client.
      example: false
    schemas-group:
      allOf:
      - $ref: '#/components/schemas/group'
      - properties:
          allowed_modes:
            $ref: '#/components/schemas/allowed_modes'
          mode:
            $ref: '#/components/schemas/components-schemas-mode'
      type: object
      required:
      - id
      - name
      - description
      - mode
      - rules_count
    schemas-groups:
      type: object
      properties:
        created_at:
          $ref: '#/components/schemas/timestamp'
        exclude:
          $ref: '#/components/schemas/exclude'
        id:
          $ref: '#/components/schemas/schemas-uuid'
        include:
          $ref: '#/components/schemas/include'
        name:
          $ref: '#/components/schemas/groups_components-schemas-name'
        require:
          $ref: '#/components/schemas/require'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    schemas-header:
      type: object
      description: The request header is used to pass additional information with
        an HTTP request. Currently supported header is 'Host'.
      properties:
        Host:
          $ref: '#/components/schemas/Host'
    schemas-health_check:
      type: object
      properties:
        enabled:
          type: boolean
          description: Determines whether to run healthchecks for a tunnel.
          default: true
          example: true
        target:
          type: string
          description: The address used to run healthchecks for a tunnel.
          example: 203.0.113.1
        type:
          type: string
          description: The type of healthcheck to run, reply or request. The default
            value is `reply`.
          enum:
          - reply
          - request
          default: reply
          example: request
    schemas-height:
      type: number
      description: Maximum height in image pixels.
      example: 768
      minimum: 1
    schemas-host:
      type: string
      format: hostname
      description: The keyless SSL name.
      example: example.com
      maxLength: 253
    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
    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
    schemas-id:
      type: string
      description: Identifier of a recommedation result.
      example: ssl_recommendation
    schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier'
    schemas-identifier: {}
    schemas-include:
      type: array
      items:
        $ref: '#/components/schemas/split_tunnel_include'
    schemas-input:
      type: object
      description: The value to be checked against.
      properties:
        id:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-uuid'
    schemas-interval:
      type: string
      description: The interval between each posture check with the third party API.
        Use "m" for minutes (e.g. "5m") and "h" for hours (e.g. "12h").
      example: 10m
    schemas-invite:
      allOf:
      - $ref: '#/components/schemas/user_invite'
      type: object
    schemas-ip:
      type: string
      description: An IPv4 or IPv6 address.
      example: 192.0.2.1
    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
    schemas-ips:
      type: array
      description: The set of IPs on the Address Map.
      items:
        $ref: '#/components/schemas/address-maps-ip'
    schemas-ipv6:
      type: string
      format: ipv6
      example: '2001:0DB8::'
    schemas-items:
      type: array
      description: The items in the List.
      items:
        type: object
        properties:
          created_at:
            $ref: '#/components/schemas/timestamp'
          value:
            $ref: '#/components/schemas/lists_components-schemas-value'
    schemas-key:
      type: string
      description: The device's public key.
      example: yek0SUYoOQ10vMGsIYAevozXUQpQtNFJFfFGqER/BGc=
    schemas-key_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            $ref: '#/components/schemas/keys_response'
    schemas-keys:
      type: object
      properties:
        name:
          $ref: '#/components/schemas/keys_components-schemas-name'
        value:
          $ref: '#/components/schemas/keys_components-schemas-value'
    schemas-kind:
      type: string
      description: The kind of the ruleset.
      enum:
      - custom
      - root
      - zone
      example: root
    schemas-last_updated:
      type: string
      description: The timestamp of when the rule was last modified.
      example: "2000-01-01T00:00:00.000000Z"
    schemas-match:
      type: array
      description: The conditions that the client must match to run the rule.
      items:
        $ref: '#/components/schemas/match_item'
    schemas-maxDurationSeconds:
      type: integer
      description: Calculates the amount of time a video occupies before the video
        is uploaded. Direct uploads occupy minutes of videos on your Stream account
        until they are expired. After upload, the upload duration is used instead.
        If a video longer than the value is uploaded, the video results in an error.
      minimum: 1
      maximum: 21600
    schemas-media_metadata:
      type: object
      description: A user modifiable key-value store used to reference other systems
        of record for managing videos.
      example:
        name: example_filename.mp4
    schemas-member:
      allOf:
      - $ref: '#/components/schemas/member'
    schemas-metadata:
      type: string
      description: What EXIF data should be preserved in the output image.
      enum:
      - keep
      - copyright
      - none
      example: none
    schemas-method:
      type: string
      description: The method to use for the health check. This defaults to 'GET'
        for HTTP/HTTPS based checks and 'connection_established' for TCP based health
        checks.
      default: GET
      example: GET
    schemas-mode:
      type: string
      description: The action to apply to a matched request.
      enum:
      - block
      - challenge
      - whitelist
      - js_challenge
      - managed_challenge
      example: challenge
    schemas-modified:
      type: string
      format: date-time
      description: The date and time the media item was last modified.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    schemas-modified_on:
      type: string
      format: date-time
      description: Last modification of DNS Firewall cluster.
      example: "2014-01-01T05:20:00.12345Z"
      readOnly: true
    schemas-modified_tunnels_collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              modified:
                type: boolean
                example: true
              modified_ipsec_tunnels:
                type: array
                items:
                  $ref: '#/components/schemas/ipsec-tunnel'
    schemas-monitor:
      description: The ID of the Monitor to use for checking the health of origins
        within this pool.
    schemas-mtu:
      type: integer
      description: The Maximum Transmission Unit (MTU) in bytes for the interconnect.
        The minimum value is 576.
      default: 1476
    schemas-name:
      type: string
      description: Organization name.
      example: Cloudflare, Inc.
      maxLength: 100
    schemas-namespace:
      type: object
      properties:
        class:
          readOnly: true
        id:
          readOnly: true
        name:
          readOnly: true
        script:
          readOnly: true
    schemas-negative_cache_ttl:
      type: number
      description: Negative DNS Cache TTL.
      default: 900
      example: 900
      nullable: true
      minimum: 30
      maximum: 36000
    schemas-operation:
      type: object
      required:
      - id
      - status
      properties:
        completed:
          type: string
          description: The RFC 3339 timestamp of when the operation was completed.
          example: "2020-01-01T08:00:00Z"
          readOnly: true
        error:
          type: string
          description: A message describing the error when the status is `failed`.
          example: This list is at the maximum number of items
          readOnly: true
        id:
          $ref: '#/components/schemas/schemas-operation_id'
        status:
          type: string
          description: The current status of the asynchronous operation.
          enum:
          - pending
          - running
          - completed
          - failed
          example: failed
          readOnly: true
    schemas-operation_id:
      type: string
      description: The unique operation ID of the asynchronous action.
      example: 4da8780eeb215e6cb7f48dd981c4ea02
      readOnly: true
    schemas-options:
      example:
        max_ttl: 15
        packet_type: icmp
      properties:
        max_ttl:
          $ref: '#/components/schemas/max_ttl'
        packet_type:
          $ref: '#/components/schemas/packet_type'
        packets_per_ttl:
          $ref: '#/components/schemas/packets_per_ttl'
        port:
          $ref: '#/components/schemas/traceroute_components-schemas-port'
        wait_time:
          $ref: '#/components/schemas/wait_time'
    schemas-organization:
      type: string
      description: Name of organization.
      example: Cloudflare, Inc.
    schemas-origin:
      type: object
      properties:
        address:
          $ref: '#/components/schemas/address'
        disabled_at:
          $ref: '#/components/schemas/disabled_at'
        enabled:
          $ref: '#/components/schemas/origin_components-schemas-enabled'
        header:
          $ref: '#/components/schemas/schemas-header'
        name:
          $ref: '#/components/schemas/origin_components-schemas-name'
        weight:
          $ref: '#/components/schemas/weight'
    schemas-output:
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/allowedOrigins'
        clippedFromVideoUID:
          $ref: '#/components/schemas/clipped_from_video_uid'
        created:
          $ref: '#/components/schemas/clipping_components-schemas-created'
        creator:
          $ref: '#/components/schemas/creator'
        endTimeSeconds:
          $ref: '#/components/schemas/end_time_seconds'
        maxDurationSeconds:
          $ref: '#/components/schemas/schemas-maxDurationSeconds'
        meta:
          $ref: '#/components/schemas/schemas-media_metadata'
        modified:
          $ref: '#/components/schemas/components-schemas-modified'
        playback:
          $ref: '#/components/schemas/playback'
        preview:
          $ref: '#/components/schemas/preview'
        requireSignedURLs:
          $ref: '#/components/schemas/requireSignedURLs'
        startTimeSeconds:
          $ref: '#/components/schemas/start_time_seconds'
        status:
          $ref: '#/components/schemas/media_state'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/thumbnailTimestampPct'
        watermark:
          $ref: '#/components/schemas/watermarkAtUpload'
    schemas-patch:
      type: object
      example:
        paused: true
      properties:
        paused:
          $ref: '#/components/schemas/paused'
        plan:
          type: object
          description: |-
            (Deprecated) Please use the /zones/:identifier/subscription API to update a zone's plan.
            The desired plan for the zone. Changing this value will create/cancel associated subscriptions. To view available plans for this zone, see Zone Plans.
          properties:
            id:
              $ref: '#/components/schemas/common_components-schemas-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
          example: full
        vanity_name_servers:
          $ref: '#/components/schemas/vanity_name_servers'
    schemas-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
    schemas-pattern:
      type: string
      title: Filter pattern
      example: example.net/*
    schemas-paused:
      type: boolean
      description: When true, indicates that the WAF package is currently paused.
    schemas-permissions:
      type: array
      description: Access permissions for this User.
      readOnly: true
      items:
        type: string
        example: '#zones:read'
        maxLength: 160
    schemas-phase:
      type: string
      description: The phase where the ruleset is executed.
      enum:
      - http_request_transform
      - http_request_late_transform
      - http_response_headers_transform
    schemas-policies:
      type: object
      properties:
        approval_groups:
          $ref: '#/components/schemas/approval_groups'
        approval_required:
          $ref: '#/components/schemas/approval_required'
        created_at:
          $ref: '#/components/schemas/timestamp'
        decision:
          $ref: '#/components/schemas/decision'
        exclude:
          $ref: '#/components/schemas/schemas-exclude'
        id:
          $ref: '#/components/schemas/components-schemas-uuid'
        include:
          $ref: '#/components/schemas/include'
        name:
          $ref: '#/components/schemas/policies_components-schemas-name'
        precedence:
          $ref: '#/components/schemas/precedence'
        purpose_justification_prompt:
          $ref: '#/components/schemas/purpose_justification_prompt'
        purpose_justification_required:
          $ref: '#/components/schemas/purpose_justification_required'
        require:
          $ref: '#/components/schemas/schemas-require'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    schemas-port:
      type: number
      description: The keyless SSL port used to commmunicate between Cloudflare and
        the client's Keyless SSL server.
      default: 24008
      example: 24008
      maxLength: 65535
    schemas-precedence:
      type: integer
      description: Precedence sets the ordering of the rules. Lower values indicate
        higher precedence. At each processing phase, applicable rules are evaluated
        in ascending order of this value.
    schemas-preview_id:
      example: p1aba936b94213e5b8dca0c0dbf1f9cc
    schemas-preview_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              preview_url:
                $ref: '#/components/schemas/preview_url'
    schemas-price:
      type: number
      description: The amount you will be billed for this plan.
      example: 0
    schemas-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
    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-----
    schemas-proxied:
      type: boolean
      description: Whether the hostname should be gray clouded (false) or orange clouded
        (true).
      default: false
      example: true
    schemas-query:
      allOf:
      - $ref: '#/components/schemas/query'
      - properties:
          dimensions:
            example:
            - accountId
            - responseCode
            items:
              enum:
              - accountId
              - responseCode
              - requestType
          filters:
            example: requestType==read AND responseCode!=200
          metrics:
            default: '["requests"]'
            example:
            - requests
            - readKiB
            items:
              enum:
              - requests
              - writeKiB
              - readKiB
          sort:
            example:
            - +requests
            - -responseCode
    schemas-railgun:
      type: object
      required:
      - id
      - name
      - status
      - enabled
      - zones_connected
      - activation
      properties:
        activation:
          $ref: '#/components/schemas/activation'
        created_on:
          $ref: '#/components/schemas/railgun_components-schemas-created_on'
        enabled:
          $ref: '#/components/schemas/railgun_components-schemas-enabled'
        id:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
        modified_on:
          $ref: '#/components/schemas/railgun_components-schemas-modified_on'
        name:
          $ref: '#/components/schemas/railgun_components-schemas-name'
        status:
          $ref: '#/components/schemas/railgun_components-schemas-status'
        upgrade_info:
          $ref: '#/components/schemas/upgrade_info'
        zones_connected:
          $ref: '#/components/schemas/zones_connected'
    schemas-railgun_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              type: object
    schemas-rate-plan:
      allOf:
      - $ref: '#/components/schemas/rate-plan'
      type: object
    schemas-ratelimit:
      type: number
      description: |-
        Ratelimit in queries per second per datacenter (applies to DNS queries sent to the origin nameservers configured on the cluster).
        Notes: A ratelimit of 0 turns off the ratelimit. Otherwise the minimum is 100.
      example: 600
      maximum: 1e+08
    schemas-ref:
      type: string
      description: A short reference tag. Allows you to select related filters.
      example: FIL-100
      maxLength: 50
    schemas-references_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            description: List of resources that reference a given pool.
            example:
            - reference_type: referrer
              resource_id: 699d98642c564d2e855e9661899b7252
              resource_name: www.example.com
              resource_type: load_balancer
            - reference_type: referral
              resource_id: f1aba936b94213e5b8dca0c0dbf1f9cc
              resource_name: Login page monitor
              resource_type: monitor
            items:
              type: object
              properties:
                reference_type:
                  type: string
                  enum:
                  - '*'
                  - referral
                  - referrer
                resource_id:
                  type: string
                resource_name:
                  type: string
                resource_type:
                  type: string
    schemas-request_model:
      type: object
      properties:
        scope:
          $ref: '#/components/schemas/scope'
        type:
          $ref: '#/components/schemas/url_normalization_components-schemas-type'
    schemas-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: 1.234213e+06
            javascript: 318236
            jpeg: 1.982048e+06
        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: 4.181364e+06
        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": 1.3496983e+07
            "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.
    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/rule_components-schemas-rule'
    schemas-requireSignedURLs:
      type: boolean
      description: Indicates whether the image can be a accessed only using it's UID.
        If set to true, a signed token needs to be generated with a signing key to
        view the image.
      default: false
      example: true
    schemas-response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/ip_components-schemas-ip'
    schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            example:
            - id: 7cf72faf220841aabcfdfab81c43c4f6
              name: Billing Read
              scopes:
              - com.cloudflare.api.account
            - id: 9d24387c6e8544e2bc4024a03991339f
              name: 'Load Balancing: Monitors and Pools Read'
              scopes:
              - com.cloudflare.api.account
            - id: d2a1802cc9a34e30852f8b33869b2f3c
              name: 'Load Balancing: Monitors and Pools Write'
              scopes:
              - com.cloudflare.api.account
            - id: 8b47d2786a534c08a1f94ee8f9f599ef
              name: Workers KV Storage Read
              scopes:
              - com.cloudflare.api.account
            - id: f7f0eda5697f475c90846e879bab8666
              name: Workers KV Storage Write
              scopes:
              - com.cloudflare.api.account
            - id: 1a71c399035b4950a1bd1466bbe4f420
              name: Workers Scripts Read
              scopes:
              - com.cloudflare.api.account
            - id: e086da7e2179491d91ee5f35b3ca210a
              name: Workers Scripts Write
              scopes:
              - com.cloudflare.api.account
            items:
              type: object
    schemas-response_model:
      type: object
      properties:
        scope:
          $ref: '#/components/schemas/scope'
        type:
          $ref: '#/components/schemas/url_normalization_components-schemas-type'
    schemas-response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    schemas-result:
      type: object
      description: Metrics on Workers KV requests.
      required:
      - rows
      - data
      - data_lag
      - min
      - max
      - totals
      - query
      properties:
        data:
          type: array
          nullable: true
          items:
            type: object
            required:
            - metrics
            properties:
              metrics:
                type: array
                description: List of metrics returned by the query.
                items: {}
        data_lag:
          type: number
          description: Number of seconds between current time and last processed event,
            i.e. how many seconds of data could be missing.
          example: 0
          minimum: 0
        max:
          description: Maximum results for each metric.
        min:
          description: Minimum results for each metric.
        query:
          $ref: '#/components/schemas/query'
        rows:
          type: number
          description: Total number of rows in the result.
          example: 2
          minimum: 0
        totals:
          description: Total results for metrics across all data.
    schemas-role:
      type: object
      required:
      - id
      - name
      - description
      - permissions
      properties:
        description:
          $ref: '#/components/schemas/description'
        id:
          $ref: '#/components/schemas/role_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/components-schemas-name'
        permissions:
          $ref: '#/components/schemas/schemas-permissions'
    schemas-route:
      type: object
      required:
      - prefix
      - nexthop
      - priority
      properties:
        created_on:
          $ref: '#/components/schemas/route_components-schemas-created_on'
        description:
          $ref: '#/components/schemas/route_components-schemas-description'
        id:
          $ref: '#/components/schemas/route_components-schemas-identifier'
        modified_on:
          $ref: '#/components/schemas/route_components-schemas-modified_on'
        nexthop:
          $ref: '#/components/schemas/nexthop'
        prefix:
          $ref: '#/components/schemas/prefix'
        priority:
          $ref: '#/components/schemas/route_components-schemas-priority'
        scope:
          $ref: '#/components/schemas/schemas-scope'
        weight:
          $ref: '#/components/schemas/schemas-weight'
    schemas-rule:
      allOf:
      - $ref: '#/components/schemas/rule'
      - properties:
          scope:
            type: object
            description: All zones owned by the user will have the rule applied.
            readOnly: true
            properties:
              email:
                $ref: '#/components/schemas/email'
              id:
                $ref: '#/components/schemas/common_components-schemas-identifier'
              type:
                description: The scope of the rule.
                enum:
                - user
                - organization
                example: user
                readOnly: true
      type: object
      required:
      - id
      - mode
      - allowed_modes
      - configuration
      - scope
    schemas-rule_identifier:
      example: 2890e6fa406311ed9b5a23f70f6fb8cf
    schemas-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
    schemas-rules_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/rule_result'
    schemas-ruleset:
      properties:
        description:
          example: ""
        id:
          example: 2f2feab2026849078ba485f918791bdc
        kind:
          example: zone
        name:
          example: default
        phase:
          example: http_request_transform
        rules:
          type: array
          description: The rules in the ruleset.
          items:
            $ref: '#/components/schemas/transform-rules_components-schemas-rule'
    schemas-scope:
      type: object
      description: Used only for ECMP routes.
      properties:
        colo_names:
          $ref: '#/components/schemas/colo_names'
        colo_regions:
          $ref: '#/components/schemas/colo_regions'
    schemas-script_name:
      type: string
      description: Name of the script to apply when the route is matched. The route
        is skipped when this is blank/missing.
      example: this-is_my_script-01
      pattern: ^[a-z0-9_][a-z0-9-_]*$
    schemas-secret:
      type: string
      description: Optional secret that will be passed in the `cf-webhook-auth` header
        when dispatching a webhook notification. Secrets are not returned in any API
        response body.
    schemas-serial_number:
      type: string
      description: The device serial number.
      example: EXAMPLEHMD6R
    schemas-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
    schemas-signature:
      type: string
      description: Certificate's signature algorithm.
      enum:
      - ECDSAWithSHA256
      - SHA1WithRSA
      - SHA256WithRSA
    schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          errors:
            type: array
            items: {}
          messages:
            type: array
            items: {}
          result:
            $ref: '#/components/schemas/api-shield'
    schemas-size:
      type: number
      description: The size of the image in bytes.
      example: 29472
      readOnly: true
    schemas-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:
            type: string
            description: The Certificate Authority that has issued this certificate.
            enum:
            - digicert
            - google
            - lets_encrypt
            example: digicert
          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/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/validation_record'
          wildcard:
            type: boolean
            description: Indicates whether the certificate covers a wildcard.
            example: false
      type: object
      description: SSL properties for the custom hostname.
    schemas-state:
      type: string
      description: The custom page state.
      enum:
      - default
      - customized
      example: default
    schemas-status:
      type: string
      description: Status of this membership.
      enum:
      - accepted
      - pending
      - rejected
      example: accepted
    schemas-subdomain:
      type: string
      description: The subdomain to be used as the destination in the proxy client.
      example: oli3n9zkz5.proxy.cloudflare-gateway.com
    schemas-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
    schemas-target:
      type: string
      description: The target hostname, IPv6, or IPv6 address.
      example: 1.1.1.1
    schemas-targets:
      type: array
      example:
      - 203.0.113.1
      - cloudflare.com
      maxLength: 10
      items:
        type: string
        description: Hosts as a hostname or IPv4/IPv6 address represented by strings.
        example: 203.0.113.1
    schemas-thumbnail_url:
      type: string
      format: uri
      description: URI to thumbnail variant for an image.
      example: https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail
      readOnly: true
    schemas-timeout:
      type: integer
      description: The timeout (in seconds) before marking the health check as failed.
      default: 5
    schemas-token:
      allOf:
      - $ref: '#/components/schemas/token'
    schemas-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
    schemas-tunnel_add_single_request:
      type: object
      required:
      - name
      - cloudflare_endpoint
      - interface_address
      properties:
        cloudflare_endpoint:
          $ref: '#/components/schemas/cloudflare_ipsec_endpoint'
        customer_endpoint:
          $ref: '#/components/schemas/customer_ipsec_endpoint'
        description:
          $ref: '#/components/schemas/ipsec-tunnel_components-schemas-description'
        interface_address:
          $ref: '#/components/schemas/interface_address'
        name:
          $ref: '#/components/schemas/ipsec-tunnel_components-schemas-name'
        psk:
          $ref: '#/components/schemas/psk'
    schemas-tunnel_deleted_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              deleted:
                type: boolean
                example: true
              deleted_ipsec_tunnel:
                type: object
    schemas-tunnel_id:
      description: UUID of the Cloudflare Tunnel serving the route.
    schemas-tunnel_modified_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              modified:
                type: boolean
                example: true
              modified_ipsec_tunnel:
                type: object
    schemas-tunnel_name:
      description: The user-friendly name of the Cloudflare Tunnel serving the route.
    schemas-tunnel_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/tunnel'
    schemas-tunnel_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            $ref: '#/components/schemas/tunnel'
    schemas-tunnel_single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              ipsec_tunnel:
                type: object
    schemas-tunnel_update_request:
      allOf:
      - $ref: '#/components/schemas/schemas-tunnel_add_single_request'
    schemas-tunnels_collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              ipsec_tunnels:
                type: array
                items:
                  $ref: '#/components/schemas/ipsec-tunnel'
    schemas-type:
      type: string
      description: The type of characteristic.
      enum:
      - header
      - cookie
      example: header
    schemas-updated_at:
      type: string
      description: The timestamp of when Page Shield was last updated.
      example: "2022-10-12T17:56:52.083582+01:00"
    schemas-uploaded:
      type: string
      format: date-time
      description: When the media item was uploaded.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    schemas-uploaded_on:
      type: string
      format: date-time
      description: This is the time the certificate was uploaded.
      example: "2019-10-28T18:11:23.37411Z"
    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
    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*
    schemas-uuid:
      description: The unique identifier for the Access group.
    schemas-validate_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              valid:
                type: boolean
                example: true
    schemas-validation_method:
      type: string
      description: Validation method in use for a certificate pack order.
      enum:
      - http
      - cname
      - txt
      example: txt
    schemas-validity_days:
      type: integer
      description: The validity period in days for the certificates ordered via Total
        TLS.
      enum:
      - 90
    schemas-value:
      type: string
      description: Enables Argo Smart Routing.
      enum:
      - "on"
      - "off"
      example: "on"
    schemas-variants:
      type: array
      description: Object specifying available variants for an image.
      example:
      - https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/thumbnail
      - https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/hero
      - https://imagedelivery.net/MTt4OTd0b0w5aj/107b9558-dd06-4bbd-5fef-9c2c16bb7900/original
      readOnly: true
      items:
        anyOf:
        - $ref: '#/components/schemas/schemas-thumbnail_url'
        - $ref: '#/components/schemas/hero_url'
        - $ref: '#/components/schemas/original_url'
    schemas-version:
      type: string
      description: The version of the rule.
      example: "1"
      pattern: ^[0-9]+$
    schemas-video_identifier:
      type: string
      description: A unique identifier for the media file.
      example: ea95132c15732412d22c1476fa83f27a
      readOnly: true
      maxLength: 32
    schemas-virtual-dns:
      allOf:
      - $ref: '#/components/schemas/virtual-dns'
      type: object
    schemas-weight:
      type: integer
      description: Optional weight of the ECMP scope - if provided.
    schemas-width:
      type: number
      description: Maximum width in image pixels.
      example: 1366
      minimum: 1
    schemas-zone:
      type: object
      properties:
        name:
          readOnly: true
    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
    scope:
      type: string
      description: The scope of the URL normalization.
      example: incoming
    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
    script-monitor_components-schemas-enabled:
      type: boolean
      description: When true, indicates that Page Shield is enabled.
      example: true
    script-monitor_components-schemas-id:
      type: string
      description: The ID of the resource.
      example: c9ef84a6bf5e47138c75d95e2f933e8f
      minLength: 32
      maxLength: 32
    script-response-collection:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: array
            items:
              properties:
                created_on:
                  readOnly: true
                etag:
                  readOnly: true
                id:
                  readOnly: true
                modified_on:
                  readOnly: true
                usage_model:
                  readOnly: true
    script-response-single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    script_identifier:
      type: string
      example: 8ee82b3a2c0f42928b8f14dae4a97121
      readOnly: true
      maxLength: 32
    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-_]*$
    search:
      type: object
      properties:
        resources:
          type: array
          description: A list of resources matching the search query.
          items:
            $ref: '#/components/schemas/resource_reference'
    search_result:
      type: object
      properties:
        result:
          $ref: '#/components/schemas/search'
    seat:
      type: object
      required:
      - seat_uid
      - gateway_seat
      - access_seat
      properties:
        access_seat:
          $ref: '#/components/schemas/access_seat'
        gateway_seat:
          $ref: '#/components/schemas/gateway_seat'
        seat_uid:
          $ref: '#/components/schemas/seat_uid'
    seat_uid:
      description: The unique API identifier for the Zero Trust seat.
    seats:
      type: object
      properties:
        access_seat:
          $ref: '#/components/schemas/access_seat'
        created_at:
          $ref: '#/components/schemas/timestamp'
        gateway_seat:
          $ref: '#/components/schemas/gateway_seat'
        seat_uid:
          $ref: '#/components/schemas/seat_uid'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    seats_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    seats_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/seats'
    seats_definition:
      type: array
      items:
        $ref: '#/components/schemas/seat'
      required:
      - seat_uid
      - gateway_seat
      - access_seat
    secret:
      type: string
      description: TSIG secret.
      example: caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c
    security_header:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone's security header.
            enum:
            - security_header
            example: security_header
          value:
            $ref: '#/components/schemas/security_header_value'
      title: Security Header
      description: Cloudflare security header for a zone.
    security_header_value:
      type: object
      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
    security_level:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - security_level
            example: security_level
          value:
            $ref: '#/components/schemas/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).
    security_level_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "off"
      - essentially_off
      - low
      - medium
      - high
      - under_attack
      default: medium
    self_hosted_props:
      type: object
      title: Self Hosted Application
      properties:
        allowed_idps:
          $ref: '#/components/schemas/allowed_idps'
        app_launcher_visible:
          $ref: '#/components/schemas/app_launcher_visible'
        auto_redirect_to_identity:
          $ref: '#/components/schemas/auto_redirect_to_identity'
        cors_headers:
          $ref: '#/components/schemas/cors_headers'
        custom_deny_message:
          $ref: '#/components/schemas/custom_deny_message'
        custom_deny_url:
          $ref: '#/components/schemas/custom_deny_url'
        domain:
          $ref: '#/components/schemas/schemas-domain'
        enable_binding_cookie:
          $ref: '#/components/schemas/enable_binding_cookie'
        http_only_cookie_attribute:
          $ref: '#/components/schemas/http_only_cookie_attribute'
        logo_url:
          $ref: '#/components/schemas/logo_url'
        name:
          $ref: '#/components/schemas/apps_components-schemas-name'
        same_site_cookie_attribute:
          $ref: '#/components/schemas/same_site_cookie_attribute'
        service_auth_401_redirect:
          $ref: '#/components/schemas/service_auth_401_redirect'
        session_duration:
          $ref: '#/components/schemas/session_duration'
        skip_interstitial:
          $ref: '#/components/schemas/skip_interstitial'
        type:
          type: string
          description: The application type.
          example: self_hosted
    sensitivity:
      type: string
      description: The sensitivity of the WAF package.
      enum:
      - high
      - medium
      - low
      - "off"
      default: high
    sent:
      type: string
      format: date-time
      description: Timestamp of when the notification was dispatched in ISO 8601 format.
      example: "2021-10-08T17:52:17.571336Z"
    serial_number:
      type: string
      description: The serial number on the uploaded certificate.
      example: "6743787633689793699141714808227354901"
    server_side_exclude:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - server_side_exclude
            example: server_side_exclude
          value:
            $ref: '#/components/schemas/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).'
    server_side_exclude_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "on"
    service:
      type: string
      description: Worker service associated with the zone and hostname.
      example: foo
    service-tokens:
      type: object
      properties:
        client_id:
          $ref: '#/components/schemas/client_id'
        created_at:
          $ref: '#/components/schemas/timestamp'
        id:
          description: The ID of the service token.
        name:
          $ref: '#/components/schemas/service-tokens_components-schemas-name'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    service-tokens_components-schemas-name:
      type: string
      description: The name of the service token.
      example: CI/CD token
    service-tokens_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/service-tokens'
    service-tokens_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/service-tokens'
    service_auth_401_redirect:
      type: boolean
      description: Returns a 401 status code when the request is blocked by a Service
        Auth policy.
      example: true
    service_mode_v2:
      type: object
      properties:
        mode:
          type: string
          description: The mode to run the WARP client under.
          example: proxy
        port:
          type: number
          description: The port number when used with proxy mode.
          example: 3000
    session_affinity:
      type: string
      description: The session_affinity specifies the type of session affinity the
        load balancer should use unless specified as "none" or ""(default). The supported
        types are "cookie" and "ip_cookie". "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.
      enum:
      - none
      - cookie
      - ip_cookie
      - '""'
      default: '""'
      example: cookie
    session_affinity_attributes:
      type: object
      description: Configures cookie attributes for session affinity cookie.
      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
        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. Value "none" means no failover
            takes place for sessions pinned to the origin (default). Value "temporary"
            means 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. Value "sticky" means the session affinity cookie is updated
            and subsequent requests are sent to the new origin. This feature is currently
            incompatible with Argo, Tiered Cache, and Bandwidth Alliance.
          enum:
          - none
          - temporary
          - sticky
          default: none
          example: sticky
    session_affinity_ttl:
      type: number
      description: Time, in seconds, until this load balancer's session affinity cookie
        expires after being created. This parameter is ignored unless a supported
        session affinity policy is set. The current default of 23 hours will be used
        unless session_affinity_ttl is explicitly set. The accepted range of values
        is between [1800, 604800]. Once the expiry time has been reached, subsequent
        requests may get sent to a different origin server.
      example: 5000
    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
    setting:
      oneOf:
      - $ref: '#/components/schemas/always_online'
      - $ref: '#/components/schemas/advanced_ddos'
      - $ref: '#/components/schemas/brotli'
      - $ref: '#/components/schemas/browser_cache_ttl'
      - $ref: '#/components/schemas/browser_check'
      - $ref: '#/components/schemas/cname_flattening'
      - $ref: '#/components/schemas/cache_level'
      - $ref: '#/components/schemas/challenge_ttl'
      - $ref: '#/components/schemas/development_mode'
      - $ref: '#/components/schemas/early_hints'
      - $ref: '#/components/schemas/edge_cache_ttl'
      - $ref: '#/components/schemas/origin_error_page_pass_thru'
      - $ref: '#/components/schemas/sort_query_string_for_cache'
      - $ref: '#/components/schemas/email_obfuscation'
      - $ref: '#/components/schemas/hotlink_protection'
      - $ref: '#/components/schemas/ip_geolocation'
      - $ref: '#/components/schemas/ipv6'
      - $ref: '#/components/schemas/websockets'
      - $ref: '#/components/schemas/sha1_support'
      - $ref: '#/components/schemas/tls_1_2_only'
      - $ref: '#/components/schemas/minify'
      - $ref: '#/components/schemas/max_upload'
      - $ref: '#/components/schemas/mobile_redirect'
      - $ref: '#/components/schemas/mirage'
      - $ref: '#/components/schemas/nel'
      - $ref: '#/components/schemas/polish'
      - $ref: '#/components/schemas/webp'
      - $ref: '#/components/schemas/prefetch_preload'
      - $ref: '#/components/schemas/privacy_pass'
      - $ref: '#/components/schemas/response_buffering'
      - $ref: '#/components/schemas/rocket_loader'
      - $ref: '#/components/schemas/security_header'
      - $ref: '#/components/schemas/security_level'
      - $ref: '#/components/schemas/server_side_exclude'
      - $ref: '#/components/schemas/ssl'
      - $ref: '#/components/schemas/ssl_recommender'
      - $ref: '#/components/schemas/tls_client_auth'
      - $ref: '#/components/schemas/true_client_ip_header'
      - $ref: '#/components/schemas/proxy_read_timeout'
      - $ref: '#/components/schemas/waf'
      - $ref: '#/components/schemas/min_tls_version'
      - $ref: '#/components/schemas/ciphers'
      - $ref: '#/components/schemas/tls_1_3'
      - $ref: '#/components/schemas/opportunistic_encryption'
      - $ref: '#/components/schemas/automatic_https_rewrites'
      - $ref: '#/components/schemas/http2'
      - $ref: '#/components/schemas/http3'
      - $ref: '#/components/schemas/origin_max_http_version'
      - $ref: '#/components/schemas/0rtt'
      - $ref: '#/components/schemas/pseudo_ipv4'
      - $ref: '#/components/schemas/always_use_https'
      - $ref: '#/components/schemas/opportunistic_onion'
      - $ref: '#/components/schemas/orange_to_orange'
      - $ref: '#/components/schemas/image_resizing'
      - $ref: '#/components/schemas/h2_prioritization'
      - $ref: '#/components/schemas/schemas-automatic_platform_optimization'
      type: object
    settings:
      type: array
      description: Settings available for the zone.
      example:
      - id: browser_check
        properties:
        - name: value
          type: toggle
      - id: browser_cache_ttl
        properties:
        - max: 3.1536e+07
          min: 1800
          name: value
          suggested_values:
          - 1800
          - 3600
          - 7200
          - 10800
          - 14400
          - 18000
          - 28800
          - 43200
          - 57600
          - 72000
          - 86400
          - 172800
          - 259200
          - 345600
          - 432000
          - 691200
          - 1.3824e+06
          - 2.0736e+06
          - 2.6784e+06
          - 5.3568e+06
          - 1.60704e+07
          - 3.1536e+07
          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: 2.4192e+06
          min: 7200
          name: value
          suggested_values:
          - 7200
          - 10800
          - 14400
          - 18000
          - 28800
          - 43200
          - 57600
          - 72000
          - 86400
          - 172800
          - 259200
          - 345600
          - 432000
          - 518400
          - 604800
          - 1.2096e+06
          - 2.4192e+06
          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
    sha1_support:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: Zone setting identifier.
            enum:
            - sha1_support
            example: sha1_support
          value:
            $ref: '#/components/schemas/sha1_support_value'
      title: Toggle SHA1 support
      description: Allow SHA1 support.
    sha1_support_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "off"
      - "on"
      default: "off"
    signature:
      type: string
      description: The type of hash used for the certificate.
      example: SHA256WithRSA
      readOnly: true
    signed_token_request:
      type: object
      readOnly: true
      properties:
        accessRules:
          type: array
          description: The optional list of access rule constraints on the token.
            Access can be blocked or allowed based on an IP, IP range, or by country.
            Access rules are evaluated from first to last. If a rule matches, the
            associated action is applied and no further rules are evaluated.
          example:
          - action: block
            country:
            - US
            - MX
            type: ip.geoip.country
          - action: allow
            ip:
            - 93.184.216.0/24
            - 2400:cb00::/32
            type: ip.src
          - action: block
            type: any
          readOnly: true
          items:
            $ref: '#/components/schemas/accessRules'
        downloadable:
          type: boolean
          description: The optional boolean value that enables using signed tokens
            to access MP4 download links for a video.
          default: false
          readOnly: true
        exp:
          type: integer
          description: The optional unix epoch timestamp that specficies the time
            after a token is not accepted. The maximum time specification is 24 hours
            from issuing time. If this field is not set, the default is one hour after
            issuing.
          readOnly: true
        id:
          type: string
          description: The optional ID of a Stream signing key. If present, the `pem`
            field is also required.
          example: ab0d4ef71g4425f8dcba9041231813000
          readOnly: true
        nbf:
          type: integer
          description: The optional unix epoch timestamp that specifies the time before
            a the token is not accepted. If this field is not set, the default is
            one hour before issuing.
          readOnly: true
        pem:
          type: string
          description: The optional base64 encoded private key in PEM format associated
            with a Stream signing key. If present, the `id` field is also required.
          example: LS0tLS1CRUdJTiBSU0EgUFJJVkFURSBLRVktLS0tLQpNSUlFcEFJQkFBS0NBUUVBc284dnBvOFpEWXRkOUgzbWlPaW1qYXAzVXlVM0oyZ3kwTUYvN1R4blJuRnkwRHpDCkxqUk9naFZsQ0hPQmxsd3NVaE9GU0lyYnN4K05tUTdBeS90TFpXSGxuVGF3UWJ5WGZGOStJeDhVSnNlSHBGV1oKNVF5Z1JYd2liSjh1MVVsZ2xlcmZHMkpueldjVXpZTzEySktZN3doSkw1ajROMWgxZFJNUXQ5Q1pkZFlCQWRzOQpCdk02cjRFMDcxQkhQekhWeDMrUTI1VWtubGdUNXIwS3FiM1E1Y0dlTlBXY1JreW1ybkJEWWR0OXR4eFFMb1dPCllzNXdsMnVYWFVYL0VGcDMwajU0Nmp6czllWExLYlNDbjJjTDZFVE96Y2x3aG9DRGx2a2VQT05rUE9LMDVKNUMKTm1TdFdhMG9hV1VGRzM0MFl3cVVrWGt4OU9tNndXd1JldU1uU1FJREFRQUJBb0lCQUFJOHo1ck5kOEdtOGJBMgo1S3pxQjI1R2lOVENwbUNJeW53NXRJWHZTQmNHcEdydUcvdlN2WG9kVlFVSVY0TWdHQkVXUEFrVzdsNWVBcHI4CnA1ZFd5SkRXYTNkdklFSE9vSEpYU3dBYksxZzZEMTNVa2NkZ1EyRGpoNVhuWDhHZCtBY2c2SmRTQWgxOWtYSHEKMk54RUtBVDB6Ri83a1g2MkRkREFBcWxmQkpGSXJodVIvZUdEVWh4L2piTTRhQ2JCcFdiM0pnRE9OYm5tS1ZoMwpxS2ZwZmRZZENZU1lzWUxrNTlxRDF2VFNwUVFUQ0VadW9VKzNzRVNhdkJzaUs1bU0vTzY5ZkRMRXNURG1MeTVQCmhEK3BMQXI0SlhNNjFwRGVBS0l3cUVqWWJybXlDRHRXTUdJNnZzZ0E1eXQzUUJaME9vV2w5QUkwdWxoZ3p4dXQKZ2ZFNTRRRUNnWUVBN0F3a0lhVEEzYmQ4Nk9jSVZnNFlrWGk1cm5aNDdsM1k4V24zcjIzUmVISXhLdkllRUtSbgp5bUlFNDFtRVBBSmlGWFpLK1VPTXdkeS9EcnFJUithT1JiT2NiV01jWUg2QzgvbG1wdVJFaXE3SW1Ub3VWcnA4CnlnUkprMWprVDA4cTIvNmg4eTBEdjJqMitsaHFXNzRNOUt0cmwxcTRlWmZRUFREL01tR1NnTWtDZ1lFQXdhY04KaSttN1p6dnJtL3NuekF2VlZ5SEtwZHVUUjNERk1naC9maC9tZ0ZHZ1RwZWtUOVV5b3FleGNYQXdwMVlhL01iQQoyNTVJVDZRbXZZTm5yNXp6Wmxic2tMV0hsYllvbWhmWnVXTHhXR3hRaEFORWdaMFVVdUVTRGMvbWx2UXZHbEtSCkZoaGhBUWlVSmdDamhPaHk1SlBiNGFldGRKd0UxK09lVWRFaE1vRUNnWUVBNG8yZ25CM1o4ck5xa3NzemlBek4KYmNuMlJVbDJOaW9pejBwS3JMaDFaT29NNE5BekpQdjJsaHRQMzdtS0htS1hLMHczRjFqTEgwSTBxZmxFVmVZbQpSU1huakdHazJjUnpBYUVzOGgrQzNheDE0Z01pZUtGU3BqNUpNOEFNbVVZOXQ1cUVhN2FYc3o0V1ZoOUlMYmVTCkRiNzlhKzVwd21LQVBrcnBsTHhyZFdrQ2dZQlNNSHVBWVdBbmJYZ1BDS2FZWklGVWJNUWNacmY0ZnpWQ2lmYksKYWZHampvRlNPZXdEOGdGK3BWdWJRTGwxbkFieU44ek1xVDRaaHhybUhpcFlqMjJDaHV2NmN3RXJtbGRiSnpwQwpBMnRaVXdkTk1ESFlMUG5lUHlZeGRJWnlsUXFVeW14SGkydElUQUxNcWtLOGV3ZWdXZHpkeGhQSlJScU5JazhrCmZIVHhnUUtCZ1FEUFc2UXIxY3F3QjNUdnVWdWR4WGRqUTdIcDFodXhrNEVWaEFJZllKNFhSTW1NUE5YS28wdHUKdUt6LzE0QW14R0dvSWJxYVc1bDMzeFNteUxhem84clNUN0tSTjVKME9JSHcrZkR5SFgxdHpVSjZCTldDcEFTcwpjbWdNK0htSzVON0w2bkNaZFJQY2IwU1hGaVRQUGhCUG1PVWFDUnpER0ZMK2JYM1VwajJKbWc9PQotLS0tLUVORCBSU0EgUFJJVkFURSBLRVktLS0tLQo=
          readOnly: true
    signed_token_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              token:
                type: string
                description: The signed token used with the signed URLs feature.
                example: eyJhbGciOiJSUzI1NiIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIn0.eyJzdWIiOiJlYTk1MTMyYzE1NzMyNDEyZDIyYzE0NzZmYTgzZjI3YSIsImtpZCI6ImU5ZGI5OTBhODI2NjZkZDU3MWM3N2Y5NDRhNWM1YzhkIiwiZXhwIjoiMTUzNzQ2MDM2NSIsIm5iZiI6IjE1Mzc0NTMxNjUifQ.OZhqOARADn1iubK6GKcn25hN3nU-hCFF5q9w2C4yup0C4diG7aMIowiRpP-eDod8dbAJubsiFuTKrqPcmyCKWYsiv0TQueukqbQlF7HCO1TV-oF6El5-7ldJ46eD-ZQ0XgcIYEKrQOYFF8iDQbqPm3REWd6BnjKZdeVrLzuRaiSnZ9qqFpGu5dfxIY9-nZKDubJHqCr3Imtb211VIG_b9MdtO92JjvkDS-rxT_pkEfTZSafl1OU-98A7KBGtPSJHz2dHORIrUiTA6on4eIXTj9aFhGiir4rSn-rn0OjPRTtJMWIDMoQyE_fwrSYzB7MPuzL2t82BWaEbHZTfixBm5A
    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"
    single_invite_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    single_member_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    single_membership_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    single_organization_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    single_request_outgoing:
      required:
      - id
      - name
      - peers
      properties:
        id:
          $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-name'
        peers:
          $ref: '#/components/schemas/peers'
    single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          errors:
            type: array
            items: {}
          messages:
            type: array
            items: {}
          result:
            $ref: '#/components/schemas/configuration'
    single_response_incoming:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              auto_refresh_seconds:
                $ref: '#/components/schemas/auto_refresh_seconds'
              checked_time:
                $ref: '#/components/schemas/time'
              created_time:
                $ref: '#/components/schemas/time'
              id:
                $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier'
              modified_time:
                $ref: '#/components/schemas/time'
              name:
                $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-name'
              peers:
                $ref: '#/components/schemas/peers'
              soa_serial:
                $ref: '#/components/schemas/soa_serial'
    single_response_outgoing:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              checked_time:
                $ref: '#/components/schemas/time'
              created_time:
                $ref: '#/components/schemas/time'
              id:
                $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier'
              last_transferred_time:
                $ref: '#/components/schemas/time'
              name:
                $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-name'
              peers:
                $ref: '#/components/schemas/peers'
              soa_serial:
                $ref: '#/components/schemas/soa_serial'
    single_response_with_list_items:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              created_at:
                $ref: '#/components/schemas/timestamp'
              description:
                $ref: '#/components/schemas/lists_components-schemas-description-2'
              id:
                $ref: '#/components/schemas/lists_components-schemas-uuid'
              items:
                $ref: '#/components/schemas/schemas-items'
              name:
                $ref: '#/components/schemas/lists_components-schemas-name-2'
              type:
                $ref: '#/components/schemas/lists_components-schemas-type'
              updated_at:
                $ref: '#/components/schemas/timestamp'
    single_role_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    single_user_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    size:
      type: number
      description: The size of the media item in bytes.
      example: 4.190963e+06
      readOnly: true
    skip_interstitial:
      type: boolean
      description: Enables automatic authentication through cloudflared.
      example: true
    soa_serial:
      type: number
      description: The serial number of the SOA for the given zone.
      example: 2.0191024e+09
    sort_query_string_for_cache:
      allOf:
      - $ref: '#/components/schemas/schemas-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/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"
    sort_query_string_for_cache_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    split_tunnel:
      type: object
      required:
      - address
      - description
      properties:
        address:
          type: string
          description: The address in CIDR format to exclude from the tunnel. If address
            is present, host must not be present.
          example: 192.0.2.0/24
        description:
          type: string
          description: A description of the split tunnel item, displayed in the client
            UI.
          example: Exclude testing domains from the tunnel
          maxLength: 100
        host:
          type: string
          description: The domain name to exclude from the tunnel. If host is present,
            address must not be present.
          example: '*.example.com'
    split_tunnel_include:
      type: object
      required:
      - address
      - description
      properties:
        address:
          type: string
          description: The address in CIDR format to include in the tunnel. If address
            is present, host must not be present.
          example: 192.0.2.0/24
        description:
          type: string
          description: A description of the split tunnel item, displayed in the client
            UI.
          example: Include testing domains from the tunnel
          maxLength: 100
        host:
          type: string
          description: The domain name to include in the tunnel. If host is present,
            address must not be present.
          example: '*.example.com'
    split_tunnel_include_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/split_tunnel_include'
    split_tunnel_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/split_tunnel'
    ssh_props:
      allOf:
      - $ref: '#/components/schemas/self_hosted_props'
      - properties:
          type:
            type: string
            description: The application type.
            example: ssh
    ssl:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - ssl
            example: ssl
          value:
            $ref: '#/components/schemas/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).'
    ssl_recommender:
      allOf:
      - properties:
          enabled:
            $ref: '#/components/schemas/ssl_recommender_enabled'
          id:
            description: Enrollment value for SSL/TLS Recommender.
            enum:
            - ssl_recommender
            example: ssl_recommender
      - properties:
          editable:
            $ref: '#/components/schemas/editable'
          modified_on:
            $ref: '#/components/schemas/properties-modified_on'
      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.
    ssl_recommender_enabled:
      type: boolean
      description: ssl-recommender enrollment setting.
      default: false
    ssl_universal_settings_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/universal'
    ssl_validation_method_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              status:
                $ref: '#/components/schemas/validation_method_components-schemas-status'
              validation_method:
                $ref: '#/components/schemas/validation_method_definition'
    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"
    ssl_verification_response_collection:
      allOf:
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/verification'
    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
          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/sslsettings'
          type:
            description: Level of validation to be used for this hostname. Domain
              validation (dv) must be used.
            enum:
            - dv
            example: dv
            readOnly: true
          wildcard:
            type: boolean
            description: Indicates whether the certificate covers a wildcard.
            example: false
      type: object
      description: SSL properties used when creating the custom hostname.
    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"
    stage:
      type: object
      description: The status of the deployment.
      readOnly: true
      properties:
        ended_on:
          type: string
          format: date-time
          description: When the stage ended.
          example: 2021-03-09T00:58:59.045655
          nullable: true
          readOnly: true
        name:
          type: string
          description: The current build stage.
          example: deploy
          pattern: queued|initialize|clone_repo|build|deploy
        started_on:
          type: string
          format: date-time
          description: When the stage started.
          example: "2021-03-09T00:55:03.923456Z"
          nullable: true
          readOnly: true
        status:
          type: string
          description: State of the current stage.
          example: success
          readOnly: true
          pattern: success|idle|active|failure|canceled
    start_time_seconds:
      type: integer
      description: Specifies the start time for the video clip in seconds.
      readOnly: true
    state:
      type: string
      description: The state that the subscription is in.
      enum:
      - Trial
      - Provisioned
      - Paid
      - AwaitingPayment
      - Cancelled
      - Failed
      - Expired
      example: Paid
      readOnly: true
    status:
      type: string
      description: Status of the token.
      enum:
      - active
      - disabled
      - expired
      example: active
    status_event_id:
      type: string
      example: 25756b2dfe6e378a06b033b670413757
    status_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              estimated_queued_users:
                $ref: '#/components/schemas/estimated_queued_users'
              estimated_total_active_users:
                $ref: '#/components/schemas/estimated_total_active_users'
              event_id:
                $ref: '#/components/schemas/status_event_id'
              max_estimated_time_minutes:
                $ref: '#/components/schemas/max_estimated_time_minutes'
              status:
                $ref: '#/components/schemas/waitingroom_components-schemas-status'
    std_dev_rtt_ms:
      type: number
      description: Standard deviation of the RTTs in ms.
    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.
        - `""`: Will map to `"geo"` if you use `region_pools`/`country_pools`/`pop_pools` otherwise `"off"`.
      enum:
      - "off"
      - geo
      - random
      - dynamic_latency
      - proximity
      - '""'
      default: '""'
      example: dynamic_latency
    stix_identifier:
      type: string
      description: 'STIX 2.1 identifier: https://docs.oasis-open.org/cti/stix/v2.1/cs02/stix-v2.1-cs02.html#_64yvzeku5a5c'
      example: ipv4-addr--baa568ec-6efe-5902-be55-0663833db537
    stored_components-schemas-result:
      allOf:
      - $ref: '#/components/schemas/schemas-result'
      - properties:
          data:
            example:
            - metrics:
              - - 2
                - 4
              - - 16
                - 32
          max:
            example:
              storedBytes: 32
              storedKeys: 4
          min:
            example:
              storedBytes: 16
              storedKeys: 2
          query:
            $ref: '#/components/schemas/components-schemas-query'
          totals:
            example:
              storedBytes: 48
              storedKeys: 6
    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.
    subcategory:
      type: object
      properties:
        beta:
          $ref: '#/components/schemas/beta'
        class:
          $ref: '#/components/schemas/class'
        description:
          $ref: '#/components/schemas/categories_components-schemas-description'
        id:
          $ref: '#/components/schemas/categories_components-schemas-id'
        name:
          $ref: '#/components/schemas/categories_components-schemas-name'
    subdomain:
      type: string
      description: The DNS Over HTTPS domain to send DNS requests to. (auto-generated).
      example: oli3n9zkz5
    subdomain-response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
            properties:
              name:
                readOnly: true
    subscription:
      allOf:
      - $ref: '#/components/schemas/subscription-v2'
      type: object
    subscription-v2:
      type: object
      properties:
        app:
          properties:
            install_id:
              $ref: '#/components/schemas/install_id'
        component_values:
          $ref: '#/components/schemas/component_values'
        currency:
          $ref: '#/components/schemas/currency'
        current_period_end:
          $ref: '#/components/schemas/current_period_end'
        current_period_start:
          $ref: '#/components/schemas/current_period_start'
        frequency:
          $ref: '#/components/schemas/frequency'
        id:
          $ref: '#/components/schemas/subscription-v2_components-schemas-identifier'
        price:
          $ref: '#/components/schemas/price'
        rate_plan:
          $ref: '#/components/schemas/rate_plan'
        state:
          $ref: '#/components/schemas/state'
        zone:
          $ref: '#/components/schemas/zone'
    subscription-v2_components-schemas-identifier:
      type: string
      description: Subscription identifier tag.
      example: 506e3185e9c882d175a2d0cb0093d9f2
      readOnly: true
      maxLength: 32
    suggested_threshold:
      type: integer
      description: The suggested threshold in requests done by the same auth_id or
        period_seconds.
      readOnly: true
    support_url:
      type: string
      description: The URL to launch when the Send Feedback button is clicked.
      example: https://1.1.1.1/help
    supported_tld:
      type: boolean
      description: Whether a particular TLD is currently supported by Cloudflare Registrar.
        Refer to [TLD Policies](https://www.cloudflare.com/tld-policies/) for a list
        of supported TLDs.
      example: true
    suspended:
      type: boolean
      description: If suspended, no health checks are sent to the origin.
      default: false
    switch_locked:
      type: boolean
      description: Whether to allow the user to turn off the WARP switch and disconnect
        the client.
      example: true
    tail-response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
            properties:
              expires_at:
                readOnly: true
              id:
                readOnly: true
              url:
                readOnly: true
    target:
      oneOf:
      - $ref: '#/components/schemas/url_target'
      description: A request condition target.
      required:
      - target
      - constraint
    target_result:
      type: object
      properties:
        colos:
          type: array
          items:
            $ref: '#/components/schemas/colo_result'
        target:
          $ref: '#/components/schemas/schemas-target'
    target_summary:
      type: object
      description: Aggregated statistics from all hops about the target.
      example:
        asn: ""
        ip: 1.1.1.1
        max_latency_ms: 0.034
        mean_latency_ms: 0.021
        min_latency_ms: 0.014
        name: 1.1.1.1
        packet_count: 3
        std_dev_latency_ms: 0.011269427669584647
    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/target'
    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
    teamnet:
      type: object
      required:
      - network
      - tunnel_id
      - comment
      - created_at
      properties:
        comment:
          $ref: '#/components/schemas/comment'
        created_at:
          description: Timestamp of when the route was created.
        deleted_at:
          type: string
          format: date-time
          description: Timestamp of when the route was deleted. If `null`, the route
            has not been deleted.
          example: "2021-01-25T18:22:34.317854Z"
          nullable: true
          readOnly: true
        network:
          $ref: '#/components/schemas/ip_network'
        tunnel_id:
          $ref: '#/components/schemas/schemas-tunnel_id'
        tunnel_name:
          $ref: '#/components/schemas/schemas-tunnel_name'
        virtual_network_id:
          $ref: '#/components/schemas/virtual_network_id'
    teamnet_components-schemas-ip:
      type: string
      example: 10.1.0.137
    telephone:
      type: string
      description: User's telephone number
      example: +1 123-123-1234
      nullable: true
      maxLength: 20
    test_connection_properties:
      type: object
      properties:
        body_hash:
          type: string
          description: Hash version of body.
          example: be27f2429421e12f200cab1da43ba301bdc70e1d
        body_size:
          type: string
          description: Size of the body in bytes.
          example: 63910 bytes
        cf-cache-status:
          type: string
          description: Lists any `cf-cache-status` present.
        cf-ray:
          type: string
          description: Lists any `cf-ray` present.
          example: 1ddd7570575207d9-LAX
        cf-wan-error:
          type: string
          description: Lists any `cf-wan-error` present.
        cloudflare:
          type: string
          description: Whether Cloudflare is enabled on the host.
          example: "on"
        connection_close:
          type: boolean
          description: Connection closed or open.
          default: true
          example: false
        elapsed_time:
          type: string
          description: Amount of seconds that the test lasted.
          example: 0.239013s
        host_name:
          type: string
          description: The hostname queried.
          example: www.example.com
        http_status:
          type: number
          description: The HTTP status response code.
          example: 200
        method:
          description: HTTP Method used to test the connection.
          enum:
          - GET
          - POST
          example: GET
        missing_headers:
          type: string
          description: What headers are missing.
          example: No Content-Length or Transfer-Encoding.
        protocol:
          type: string
          description: Protocol used to test the connection.
          example: HTTP/1.1
        railgun:
          type: string
          description: Indicates if Railgun is enabled on the queried hostname.
          example: "on"
        response_status:
          type: string
          description: HTTP Status code.
          example: 200 OK
        url:
          type: string
          description: Url of the domain you can compare the connection to.
          example: https://www.cloudflare.com
    test_connection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/test_connection_properties'
    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
    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
    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/auth_id_tokens'
            data_points:
              $ref: '#/components/schemas/data_points'
            last_updated:
              $ref: '#/components/schemas/timestamp'
            p50:
              $ref: '#/components/schemas/p50'
            p90:
              $ref: '#/components/schemas/p90'
            p99:
              $ref: '#/components/schemas/p99'
            period_seconds:
              $ref: '#/components/schemas/period_seconds'
            requests:
              $ref: '#/components/schemas/requests'
            suggested_threshold:
              $ref: '#/components/schemas/suggested_threshold'
    thumbnail_url:
      type: string
      format: uri
      description: The media item's thumbnail URI. This field is omitted until encoding
        is complete.
      example: https://customer-m033z5x00ks6nunl.cloudflarestream.com/ea95132c15732412d22c1476fa83f27a/thumbnails/thumbnail.jpg
      readOnly: true
    thumbnailTimestampPct:
      type: number
      description: The timestamp for a thumbnail image calculated as a percentage
        value of the video's duration. To convert from a second-wise timestamp to
        a percentage, divide the desired timestamp by the total duration of the video.  If
        this value is not set, the default thumbnail image is taken from 0s of the
        video.
      default: 0
      example: 0.529241
      minimum: 0
      maximum: 1
    time:
      type: string
      description: The time for a specific event.
      example: "2019-10-24T17:09:42.883908+01:00"
    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
    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/bandwidth'
          pageviews:
            $ref: '#/components/schemas/pageviews'
          requests:
            $ref: '#/components/schemas/schemas-requests'
          since:
            $ref: '#/components/schemas/since'
          threats:
            $ref: '#/components/schemas/threats'
          uniques:
            $ref: '#/components/schemas/uniques'
          until:
            $ref: '#/components/schemas/until'
    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/bandwidth_by_colo'
          requests:
            $ref: '#/components/schemas/requests_by_colo'
          since:
            $ref: '#/components/schemas/since'
          threats:
            $ref: '#/components/schemas/threats'
          until:
            $ref: '#/components/schemas/until'
    timestamp:
      type: string
      format: date-time
      example: "2014-01-01T05:20:00.12345Z"
      readOnly: true
    tls:
      type: string
      description: The type of TLS termination associated with the application.
      enum:
      - "off"
      - flexible
      - full
      - strict
      example: full
    tls-settings:
      type: object
      description: TLS interception settings.
      properties:
        enabled:
          type: boolean
          description: Enable inspecting encrypted HTTP traffic.
          example: true
    tls_1_2_only:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: Zone setting identifier.
            enum:
            - tls_1_2_only
            example: tls_1_2_only
          value:
            $ref: '#/components/schemas/tls_1_2_only_value'
      title: TLS1.2 only
      description: Only allows TLS1.2.
    tls_1_2_only_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "off"
      - "on"
      default: "off"
    tls_1_3:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - tls_1_3
            example: tls_1_3
          value:
            $ref: '#/components/schemas/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_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"
    tls_client_auth:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - tls_client_auth
            example: tls_client_auth
          value:
            $ref: '#/components/schemas/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).
    tls_client_auth_value:
      type: string
      description: value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "on"
    token:
      type: object
      required:
      - id
      - name
      - status
      - policies
      properties:
        condition:
          $ref: '#/components/schemas/condition'
        expires_on:
          $ref: '#/components/schemas/expires_on'
        id:
          $ref: '#/components/schemas/components-schemas-identifier'
        issued_on:
          $ref: '#/components/schemas/issued_on'
        modified_on:
          $ref: '#/components/schemas/modified_on'
        name:
          $ref: '#/components/schemas/name'
        not_before:
          $ref: '#/components/schemas/not_before'
        policies:
          $ref: '#/components/schemas/policies'
        status:
          $ref: '#/components/schemas/status'
    total-tls_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
    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: 2.147483647e+09
    total_tls_settings_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              certificate_authority:
                $ref: '#/components/schemas/schemas-certificate_authority'
              enabled:
                $ref: '#/components/schemas/total-tls_components-schemas-enabled'
              validity_days:
                $ref: '#/components/schemas/schemas-validity_days'
    totals:
      type: object
      description: Breakdown of totals by data type.
      properties:
        bandwidth:
          $ref: '#/components/schemas/bandwidth'
        pageviews:
          $ref: '#/components/schemas/pageviews'
        requests:
          $ref: '#/components/schemas/schemas-requests'
        since:
          $ref: '#/components/schemas/since'
        threats:
          $ref: '#/components/schemas/threats'
        uniques:
          $ref: '#/components/schemas/uniques'
        until:
          $ref: '#/components/schemas/until'
    totals_by_colo:
      type: object
      description: Breakdown of totals by data type.
      properties:
        bandwidth:
          $ref: '#/components/schemas/bandwidth_by_colo'
        requests:
          $ref: '#/components/schemas/requests_by_colo'
        since:
          $ref: '#/components/schemas/since'
        threats:
          $ref: '#/components/schemas/threats'
        until:
          $ref: '#/components/schemas/until'
    traceroute_components-schemas-ip:
      type: string
      description: IP address of the node.
    traceroute_components-schemas-name:
      type: string
      description: Host name of the address, this may be the same as the IP address.
    traceroute_components-schemas-port:
      type: integer
      description: For UDP and TCP, specifies the destination port. For ICMP, specifies
        the initial ICMP sequence value. Default value 0 will choose the best value
        to use for each protocol.
      default: 0
      minimum: 0
      maximum: 65535
    traceroute_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/target_result'
    traceroute_time_ms:
      type: integer
      description: Total time of traceroute in ms.
    traditional_allow_rule:
      allOf:
      - $ref: '#/components/schemas/rule_components-schemas-base-2'
      - properties:
          allowed_modes:
            $ref: '#/components/schemas/allowed_modes_allow_traditional'
          mode:
            $ref: '#/components/schemas/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
    traditional_deny_rule:
      allOf:
      - $ref: '#/components/schemas/rule_components-schemas-base-2'
      - properties:
          allowed_modes:
            $ref: '#/components/schemas/allowed_modes_deny_traditional'
          default_mode:
            $ref: '#/components/schemas/default_mode'
          mode:
            $ref: '#/components/schemas/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
    traffic:
      type: string
      description: The wirefilter expression to be used for traffic matching.
      example: http.request.uri matches ".*a/partial/uri.*" and http.request.host
        in $01302951-49f9-47c9-a400-0297e60b6a10
    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
    transfer_in:
      description: Statuses for domain transfers into Cloudflare Registrar.
      properties:
        accept_foa:
          description: Form of authorization has been accepted by the registrant.
          example: needed
        approve_transfer:
          description: Shows transfer status with the registry.
          example: unknown
        can_cancel_transfer:
          type: boolean
          description: Indicates if cancellation is still possible.
          example: true
        disable_privacy:
          description: Privacy guards are disabled at the foreign registrar.
        enter_auth_code:
          description: Auth code has been entered and verified.
          example: needed
        unlock_domain:
          description: Domain is unlocked at the foreign registrar.
    transform-rules_components-schemas-rule:
      properties:
        action:
          example: rewrite
        action_parameters:
          $ref: '#/components/schemas/schemas-action_parameters'
        description:
          example: change request based on ip location
        expression:
          example: ip.geoip.country eq "AL"
        id:
          example: 3a03d665bac047339bb530ecb439a90d
        version:
          example: "1"
    true_client_ip_header:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - true_client_ip_header
            example: true_client_ip_header
          value:
            $ref: '#/components/schemas/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"
    true_client_ip_header_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    tsig:
      type: object
      required:
      - id
      - name
      - secret
      - algo
      properties:
        algo:
          $ref: '#/components/schemas/algo'
        id:
          $ref: '#/components/schemas/tsig_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/tsig_components-schemas-name'
        secret:
          $ref: '#/components/schemas/secret'
    tsig_components-schemas-identifier:
      example: 69cd1e104af3e6ed3cb344f263fd0d5a
    tsig_components-schemas-name:
      type: string
      description: TSIG key name.
      example: tsig.customer.cf.
    tsig_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/tsig'
    tsig_id:
      type: string
      description: TSIG authentication will be used for zone transfer if configured.
      example: 69cd1e104af3e6ed3cb344f263fd0d5a
    ttl:
      anyOf:
      - type: number
        example: 3600
        minimum: 60
        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: 3600
    tunnel:
      type: object
      description: A Cloudflare Tunnel that connects your origin to Cloudflare's edge.
      properties:
        account_tag:
          $ref: '#/components/schemas/cf_account_id'
        connections:
          $ref: '#/components/schemas/connections'
        conns_active_at:
          $ref: '#/components/schemas/conns_active_at'
        conns_inactive_at:
          $ref: '#/components/schemas/conns_inactive_at'
        created_at:
          $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-created_at'
        deleted_at:
          $ref: '#/components/schemas/schemas-deleted_at'
        id:
          $ref: '#/components/schemas/tunnel_id'
        metadata:
          $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-metadata'
        name:
          $ref: '#/components/schemas/tunnel_name'
        remote_config:
          $ref: '#/components/schemas/remote_config'
        status:
          $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-status'
        tun_type:
          $ref: '#/components/schemas/tunnel_type'
    tunnel_add_single_request:
      type: object
      required:
      - name
      - customer_gre_endpoint
      - cloudflare_gre_endpoint
      - interface_address
      properties:
        cloudflare_gre_endpoint:
          $ref: '#/components/schemas/cloudflare_gre_endpoint'
        customer_gre_endpoint:
          $ref: '#/components/schemas/customer_gre_endpoint'
        description:
          $ref: '#/components/schemas/gre-tunnel_components-schemas-description'
        health_check:
          $ref: '#/components/schemas/health_check'
        interface_address:
          $ref: '#/components/schemas/interface_address'
        mtu:
          $ref: '#/components/schemas/mtu'
        name:
          $ref: '#/components/schemas/gre-tunnel_components-schemas-name'
        ttl:
          $ref: '#/components/schemas/components-schemas-ttl'
    tunnel_connection:
      type: object
      description: A connection between cloudflared and a Cloudflare data center.
      properties:
        arch:
          $ref: '#/components/schemas/arch'
        config_version:
          $ref: '#/components/schemas/config_version'
        conns:
          $ref: '#/components/schemas/connections'
        features:
          $ref: '#/components/schemas/schemas-features'
        id:
          $ref: '#/components/schemas/connection_id'
        run_at:
          $ref: '#/components/schemas/run_at'
        version:
          $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-version'
    tunnel_connections_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/tunnel_connection'
    tunnel_deleted_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              deleted:
                type: boolean
                example: true
              deleted_gre_tunnel:
                type: object
    tunnel_health_check:
      type: object
      properties:
        enabled:
          type: boolean
          description: Determines whether to run healthchecks for a tunnel.
          default: true
          example: true
        target:
          type: string
          description: The address used to run healthchecks for a tunnel. This field
            defaults to `customer_gre_endpoint address`.
          example: 203.0.113.1
        type:
          type: string
          description: The type of healthcheck to run, reply or request. The default
            value is `reply`.
          enum:
          - reply
          - request
          default: reply
          example: request
    tunnel_id:
      type: string
      description: UUID of the tunnel.
      example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
      readOnly: true
      maxLength: 36
    tunnel_modified_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              modified:
                type: boolean
                example: true
              modified_gre_tunnel:
                type: object
    tunnel_name:
      type: string
      description: A user-friendly name for the tunnel.
      example: blog
    tunnel_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/argo-tunnel'
    tunnel_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    tunnel_response_token:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: string
    tunnel_secret:
      type: string
      description: Sets the password required to run a locally-managed tunnel. Must
        be at least 32 bytes and encoded as a base64 string.
      example: AQIDBAUGBwgBAgMEBQYHCAECAwQFBgcIAQIDBAUGBwg=
    tunnel_single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              gre_tunnel:
                type: object
    tunnel_type:
      type: string
      description: The type of tunnel.
      enum:
      - cfd_tunnel
      example: cfd_tunnel
    tunnel_update_request:
      allOf:
      - $ref: '#/components/schemas/tunnel_add_single_request'
    tunnels_collection_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            properties:
              gre_tunnels:
                type: array
                items:
                  $ref: '#/components/schemas/gre-tunnel'
    tus_resumable:
      type: string
      description: |-
        Specifies the TUS protocol version. This value must be included in every upload request.
        Notes: The only supported version of TUS protocol is 1.0.0.
      enum:
      - 1.0.0
      example: 1.0.0
    two_factor_authentication_enabled:
      type: boolean
      description: Indicates whether two-factor authentication is enabled for the
        user account. Does not apply to API authentication.
      default: false
      readOnly: true
    type:
      type: string
      description: The billing item type.
      example: charge
      readOnly: true
      maxLength: 30
    ua-rules:
      allOf:
      - $ref: '#/components/schemas/firewalluablock'
      type: object
    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
    ua-rules_components-schemas-id:
      type: string
      description: The unique identifier of the User Agent Blocking rule.
      example: 372e67954025e0ba6aaa6d586b9e0b59
      readOnly: true
      maxLength: 32
    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
    uid:
      description: The unique API identifier for the user.
    uniques:
      type: object
      properties:
        all:
          type: integer
          description: Total number of unique IP addresses within the time range.
    unit_price:
      type: number
      description: The unit price of the addon.
      example: 1
      readOnly: true
    universal:
      type: object
      properties:
        enabled:
          $ref: '#/components/schemas/components-schemas-enabled'
    unrevoke_devices_request:
      type: array
      description: A list of device ids to unrevoke.
      maxLength: 200
      items:
        $ref: '#/components/schemas/uuid'
    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"
    update-zone-settings-response:
      properties:
        enabled:
          $ref: '#/components/schemas/script-monitor_components-schemas-enabled'
        updated_at:
          $ref: '#/components/schemas/schemas-updated_at'
        use_cloudflare_reporting_endpoint:
          $ref: '#/components/schemas/use_cloudflare_reporting_endpoint'
        use_connection_url_path:
          $ref: '#/components/schemas/use_connection_url_path'
    update_catch_all_rule_properties:
      type: object
      required:
      - actions
      - matchers
      properties:
        actions:
          $ref: '#/components/schemas/catchall-actions'
        enabled:
          $ref: '#/components/schemas/rules_components-schemas-enabled'
        matchers:
          $ref: '#/components/schemas/catchall-matchers'
        name:
          $ref: '#/components/schemas/rules_components-schemas-name'
    update_custom_profile:
      type: object
      title: Update custom profile
      properties:
        description:
          type: string
          description: The description of the profile.
          example: A standard CVV card number
        entries:
          type: array
          description: The entries for this profile. Array elements with IDs are modifying
            the existing entry with that ID. Elements without ID will create new entries.
            Any entry not in the list will be deleted.
          items:
            $ref: '#/components/schemas/custom_entry'
        name:
          type: string
          description: The name of the profile.
          example: Generic CVV Card Number
    update_input_request:
      properties:
        defaultCreator:
          $ref: '#/components/schemas/live_input_default_creator'
        meta:
          $ref: '#/components/schemas/live_input_metadata'
        recording:
          $ref: '#/components/schemas/live_input_recording_settings'
    update_output_request:
      required:
      - enabled
      properties:
        enabled:
          $ref: '#/components/schemas/output_enabled'
    update_predefined_profile:
      type: object
      title: Update predefined profile
      properties:
        entries:
          type: array
          description: The entries for this profile.
          items:
            properties:
              enabled:
                type: boolean
                description: Wheter the entry is enabled or not.
                example: true
              id:
                $ref: '#/components/schemas/entry_id'
    update_rule_properties:
      type: object
      required:
      - actions
      - matchers
      properties:
        actions:
          $ref: '#/components/schemas/actions'
        enabled:
          $ref: '#/components/schemas/rules_components-schemas-enabled'
        matchers:
          $ref: '#/components/schemas/matchers'
        name:
          $ref: '#/components/schemas/rules_components-schemas-name'
        priority:
          $ref: '#/components/schemas/components-schemas-priority'
    update_rules:
      type: array
      items:
        $ref: '#/components/schemas/create_rule'
    update_ruleset:
      type: object
      description: A ruleset object.
      required:
      - rules
      properties:
        description:
          $ref: '#/components/schemas/rulesets_components-schemas-description'
        rules:
          $ref: '#/components/schemas/create_update_rules'
    updated:
      type: string
      format: date-time
      description: When the device was updated.
      example: "2017-06-14T00:00:00Z"
    updated_at:
      type: string
      format: date-time
      description: The time when the certificate was updated.
      example: "2100-01-01T05:20:00Z"
      readOnly: true
    upgrade_info:
      type: object
      description: Defined when the Railgun version is out of date from the latest
        release from Cloudflare.
      properties:
        download_link:
          type: string
          description: An HTTP link to download the latest Railgun binary.
          example: https://www.cloudflare.com/downloads/railgun
        latest_version:
          type: string
          description: Latest version of the Railgun receiver available to install.
          example: 1.0.0
    upload_length:
      type: integer
      description: Indicates the size of the entire upload in bytes. The value must
        be a non-negative integer.
      minimum: 0
    uploaded:
      type: string
      format: date-time
      description: The date and time the media item was uploaded.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    uploaded_on:
      type: string
      format: date-time
      description: When the certificate was uploaded to Cloudflare.
      example: "2014-01-01T05:20:00Z"
      readOnly: true
    uptycs_config_request:
      type: object
      required:
      - client_key
      - customer_id
      - client_secret
      properties:
        client_key:
          type: string
          description: The Uptycs client secret.
          example: example client key
        client_secret:
          type: string
          description: The Uptycs client secret.
          example: example client secret
        customer_id:
          type: string
          description: The Uptycs customer ID.
          example: example customer id
    url:
      type: string
      format: uri
      description: The URL associated with the custom page.
      default: ""
      example: http://www.example.com
    url_normalization_components-schemas-type:
      type: string
      description: The type of URL normalization performed by Cloudflare.
      example: cloudflare
    url_param:
      type: object
      properties:
        url:
          $ref: '#/components/schemas/components-schemas-url'
    url_target:
      type: object
      description: URL target.
      properties:
        constraint:
          allOf:
          - $ref: '#/components/schemas/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
    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/*
    usage-model-response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
            properties:
              usage_model:
                readOnly: true
    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
    use_connection_url_path:
      type: boolean
      description: When true, the paths associated with connections URLs will also
        be analyzed.
      example: true
    user:
      type: object
      properties:
        email:
          $ref: '#/components/schemas/email'
        id:
          $ref: '#/components/schemas/uuid'
        name:
          type: string
          description: The enrolled device user's name.
          example: John Appleseed
    user_invite:
      allOf:
      - $ref: '#/components/schemas/base'
      - properties:
          status:
            description: Current status of the invitation.
            enum:
            - pending
            - accepted
            - rejected
            - expired
            example: accepted
    user_subscription_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/subscription'
    user_subscription_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    users:
      type: object
      properties:
        access_seat:
          $ref: '#/components/schemas/schemas-access_seat'
        active_device_count:
          $ref: '#/components/schemas/active_device_count'
        created_at:
          $ref: '#/components/schemas/timestamp'
        email:
          $ref: '#/components/schemas/components-schemas-email'
        gateway_seat:
          $ref: '#/components/schemas/schemas-gateway_seat'
        id:
          $ref: '#/components/schemas/users_components-schemas-id'
        last_successful_login:
          $ref: '#/components/schemas/last_successful_login'
        name:
          $ref: '#/components/schemas/users_components-schemas-name'
        seat_uid:
          $ref: '#/components/schemas/seat_uid'
        uid:
          $ref: '#/components/schemas/uid'
        updated_at:
          $ref: '#/components/schemas/timestamp'
    users_components-schemas-id:
      description: The ID of the user.
      example: f3b12456-80dd-4e89-9f5f-ba3dfff12365
    users_components-schemas-identifier:
      example: 699d98642c564d2e855e9661899b7252
    users_components-schemas-name:
      type: string
      description: The name of the user.
      example: Jane Doe
    users_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result_info:
            type: object
            properties:
              count:
                example: 1
              page:
                example: 1
              per_page:
                example: 100
              total_count:
                example: 1
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/users'
    uuid:
      type: string
      description: UUID
      example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415
      readOnly: true
      maxLength: 36
    validate_ownership_response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            properties:
              valid:
                type: boolean
                example: true
    validate_pattern:
      type: object
      title: Pattern
      description: A request to validate a pattern
      required:
      - regex
      properties:
        regex:
          type: string
          description: The regex pattern.
          example: ^4[0-9]{6,}$
    validate_response:
      allOf:
      - $ref: '#/components/schemas/api-response-common'
      - properties:
          result:
            type: object
            nullable: true
            properties:
              message:
                type: string
                example: ""
              valid:
                type: boolean
                example: true
    validation_method:
      type: string
      description: Validation Method selected for the order.
      enum:
      - txt
      - http
      - email
      example: txt
    validation_method_components-schemas-status:
      type: string
      description: Result status.
      example: pending_validation
    validation_method_definition:
      type: string
      description: Desired validation method.
      enum:
      - http
      - cname
      - txt
      - email
      example: txt
    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
    validity_days:
      type: integer
      description: Validity Days selected for the order.
      enum:
      - 14
      - 30
      - 90
      - 365
    value:
      type: string
      description: The token value.
      example: 8M7wS6hCpXVc-DoRnPPY_UCWPgy8aea4Wy6kCe5T
      readOnly: true
      minLength: 40
      maxLength: 80
    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
    variant_generation_request:
      type: object
      required:
      - id
      - options
      properties:
        id:
          $ref: '#/components/schemas/variants_components-schemas-identifier'
        neverRequireSignedURLs:
          $ref: '#/components/schemas/neverRequireSignedURLs'
        options:
          $ref: '#/components/schemas/options'
    variant_list_response:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            $ref: '#/components/schemas/variants_response'
    variant_patch_request:
      type: object
      required:
      - options
      properties:
        neverRequireSignedURLs:
          $ref: '#/components/schemas/neverRequireSignedURLs'
        options:
          $ref: '#/components/schemas/options'
    variant_public_request:
      type: object
      properties:
        hero:
          type: object
    variant_response:
      type: object
      properties:
        variant:
          type: object
    variant_simple_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/variant_response'
    variants:
      allOf:
      - $ref: '#/components/schemas/components-schemas-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.'
    variants_components-schemas-identifier:
      example: hero
      maxLength: 99
      pattern: ^[a-zA-Z0-9]$
    variants_response:
      type: object
      properties:
        variants:
          $ref: '#/components/schemas/variant_public_request'
    variants_response_value:
      properties:
        result:
          allOf:
          - $ref: '#/components/schemas/variants'
          - required:
            - value
            properties:
              value:
                $ref: '#/components/schemas/variants_value'
    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: {}
    verification:
      type: object
      required:
      - certificate_status
      properties:
        brand_check:
          $ref: '#/components/schemas/brand_check'
        cert_pack_uuid:
          $ref: '#/components/schemas/cert_pack_uuid'
        certificate_status:
          $ref: '#/components/schemas/certificate_status'
        signature:
          $ref: '#/components/schemas/schemas-signature'
        validation_method:
          $ref: '#/components/schemas/schemas-validation_method'
        verification_info:
          $ref: '#/components/schemas/verification_info'
        verification_status:
          $ref: '#/components/schemas/verification_status'
        verification_type:
          $ref: '#/components/schemas/verification_type'
    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: {}
    verification_info:
      type: object
      description: Certificate's required verification information.
      enum:
      - record_name
      - record_value
      - http_url
      - http_body
      - cname
      - cname_target
      - txt_name
      - txt_value
      properties:
        record_name:
          type: string
          format: hostname
          description: Name of CNAME record.
          example: b3b90cfedd89a3e487d3e383c56c4267.example.com
        record_target:
          type: string
          format: hostname
          description: Target of CNAME record.
          example: 6979be7e4cfc9e5c603e31df7efac9cc60fee82d.comodoca.com
    verification_status:
      type: boolean
      description: Status of the required verification information, omitted if verification
        status is unknown.
      example: true
    verification_type:
      type: string
      description: Method of verification.
      enum:
      - cname
      - meta tag
      example: cname
    verified:
      type: string
      format: date-time
      description: The date and time the destination address has been verified. Null
        means not verified yet.
      example: "2014-01-02T02:20:00Z"
      readOnly: true
    version:
      type: string
      description: The version of the ruleset.
      example: "1"
      pattern: ^[0-9]+$
    video_copy_request:
      required:
      - url
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/allowedOrigins'
        creator:
          $ref: '#/components/schemas/creator'
        requireSignedURLs:
          $ref: '#/components/schemas/requireSignedURLs'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/thumbnailTimestampPct'
        url:
          type: string
          format: uri
          description: A video's URL. The server must be publicly routable and support
            `HTTP HEAD` requests and `HTTP GET` range requests. The server should
            respond to `HTTP HEAD` requests with a `content-range` header that includes
            the size of the file.
          example: https://example.com/myvideo.mp4
        watermark:
          $ref: '#/components/schemas/watermark_at_upload'
    video_identifier:
      type: string
      description: A unique identifier for the MP4 file.
      example: ea95132c15732412d22c1476fa83f27a
      readOnly: true
      maxLength: 32
    video_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/videos'
      - properties:
          range:
            type: integer
            description: The total number of remaining videos based on cursor position.
            example: 1000
            readOnly: true
          total:
            type: integer
            description: The total number of videos that match the provided filters.
            example: 35586
            readOnly: true
    video_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    videoClipStandard:
      type: object
      required:
      - clippedFromVideoUID
      - startTimeSeconds
      - endTimeSeconds
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/allowedOrigins'
        clippedFromVideoUID:
          $ref: '#/components/schemas/clipped_from_video_uid'
        creator:
          $ref: '#/components/schemas/creator'
        endTimeSeconds:
          $ref: '#/components/schemas/end_time_seconds'
        maxDurationSeconds:
          $ref: '#/components/schemas/schemas-maxDurationSeconds'
        requireSignedURLs:
          $ref: '#/components/schemas/requireSignedURLs'
        startTimeSeconds:
          $ref: '#/components/schemas/start_time_seconds'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/thumbnailTimestampPct'
        watermark:
          $ref: '#/components/schemas/watermarkAtUpload'
    videos:
      type: object
      properties:
        allowedOrigins:
          $ref: '#/components/schemas/allowedOrigins'
        created:
          $ref: '#/components/schemas/schemas-created'
        creator:
          $ref: '#/components/schemas/creator'
        duration:
          $ref: '#/components/schemas/schemas-duration'
        input:
          $ref: '#/components/schemas/input'
        liveInput:
          $ref: '#/components/schemas/liveInput'
        maxDurationSeconds:
          $ref: '#/components/schemas/maxDurationSeconds'
        meta:
          $ref: '#/components/schemas/media_metadata'
        modified:
          $ref: '#/components/schemas/schemas-modified'
        nft:
          $ref: '#/components/schemas/nft'
        playback:
          $ref: '#/components/schemas/playback'
        preview:
          $ref: '#/components/schemas/preview'
        readyToStream:
          $ref: '#/components/schemas/readyToStream'
        requireSignedURLs:
          $ref: '#/components/schemas/requireSignedURLs'
        size:
          $ref: '#/components/schemas/size'
        status:
          $ref: '#/components/schemas/media_status'
        thumbnail:
          $ref: '#/components/schemas/thumbnail_url'
        thumbnailTimestampPct:
          $ref: '#/components/schemas/thumbnailTimestampPct'
        uid:
          $ref: '#/components/schemas/videos_components-schemas-identifier'
        uploadExpiry:
          $ref: '#/components/schemas/oneTimeUploadExpiry'
        uploaded:
          $ref: '#/components/schemas/uploaded'
        watermark:
          $ref: '#/components/schemas/watermarks'
    videos_components-schemas-identifier:
      type: string
      description: A Cloudflare-generated unique identifier for a media item.
      example: ea95132c15732412d22c1476fa83f27a
      readOnly: true
      maxLength: 32
    virtual-dns:
      type: object
      required:
      - id
      - name
      - origin_ips
      - virtual_dns_ips
      - minimum_cache_ttl
      - maximum_cache_ttl
      - deprecate_any_requests
      - ecs_fallback
      - modified_on
      properties:
        deprecate_any_requests:
          $ref: '#/components/schemas/deprecate_any_requests'
        ecs_fallback:
          $ref: '#/components/schemas/ecs_fallback'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        maximum_cache_ttl:
          $ref: '#/components/schemas/maximum_cache_ttl'
        minimum_cache_ttl:
          $ref: '#/components/schemas/minimum_cache_ttl'
        modified_on:
          $ref: '#/components/schemas/schemas-modified_on'
        name:
          $ref: '#/components/schemas/virtual-dns_components-schemas-name'
        negative_cache_ttl:
          $ref: '#/components/schemas/schemas-negative_cache_ttl'
        origin_ips:
          $ref: '#/components/schemas/origin_ips'
        ratelimit:
          $ref: '#/components/schemas/schemas-ratelimit'
        virtual_dns_ips:
          $ref: '#/components/schemas/virtual_dns_ips'
    virtual-dns_components-schemas-name:
      type: string
      description: DNS Firewall Cluster Name.
      example: My Awesome DNS Firewall cluster
      maxLength: 160
    virtual-network:
      type: object
      required:
      - id
      - name
      - is_default_network
      - comment
      - created_at
      properties:
        comment:
          $ref: '#/components/schemas/schemas-comment'
        created_at:
          description: Timestamp of when the virtual network was created.
        deleted_at:
          description: Timestamp of when the virtual network was deleted. If `null`,
            the virtual network has not been deleted.
        id:
          $ref: '#/components/schemas/vnet_id'
        is_default_network:
          $ref: '#/components/schemas/is_default_network'
        name:
          $ref: '#/components/schemas/vnet_name'
    virtual_dns_ips:
      type: array
      example:
      - 203.0.113.1
      - 203.0.113.254
      - 2001:DB8:AB::CF
      - 2001:DB8:CD::CF
      items:
        anyOf:
        - type: string
          format: ipv4
          description: Origin DNS Server IPv4 Address.
          example: 203.0.113.1
        - type: string
          format: ipv6
          description: Origin DNS Server IPv6 Address.
          example: 2001:DB8:ab::CF
    virtual_dns_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/virtual-dns'
    virtual_dns_single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/virtual-dns'
    virtual_network_id:
      description: UUID of the Tunnel Virtual Network this route belongs to. If no
        virtual networks are configured, the route is assigned to the default virtual
        network of the account.
    vnc_props:
      allOf:
      - $ref: '#/components/schemas/self_hosted_props'
      - properties:
          type:
            type: string
            description: The application type.
            example: vnc
    vnet_id:
      type: string
      description: UUID of the virtual network.
      example: f70ff985-a4ef-4643-bbbc-4a0ed4fc8415
      readOnly: true
      maxLength: 36
    vnet_name:
      type: string
      description: A user-friendly name for the virtual network.
      example: us-east-1-vpc
    vnet_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/virtual-network'
    vnet_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    waf:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - waf
            example: waf
          value:
            $ref: '#/components/schemas/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).
    waf_action:
      description: The WAF rule action to apply.
      enum:
      - challenge
      - block
      - simulate
      - disable
      - default
    waf_rewrite_action:
      description: The WAF rule action to apply.
      enum:
      - challenge
      - block
      - simulate
      - disable
      - default
    waf_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "on"
      - "off"
      default: "off"
    wait_time:
      type: integer
      description: Set the time (in seconds) to wait for a response to a probe.
      default: 1
      minimum: 1
      maximum: 5
    waiting_room_id:
      example: 699d98642c564d2e855e9661899b7252
    waiting_room_id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/waiting_room_id'
    waitingroom:
      type: object
      properties:
        cookie_attributes:
          $ref: '#/components/schemas/cookie_attributes'
        created_on:
          $ref: '#/components/schemas/timestamp'
        custom_page_html:
          $ref: '#/components/schemas/custom_page_html'
        default_template_language:
          $ref: '#/components/schemas/default_template_language'
        description:
          $ref: '#/components/schemas/waitingroom_components-schemas-description'
        disable_session_renewal:
          $ref: '#/components/schemas/disable_session_renewal'
        host:
          $ref: '#/components/schemas/components-schemas-host'
        id:
          $ref: '#/components/schemas/waiting_room_id'
        json_response_enabled:
          $ref: '#/components/schemas/json_response_enabled'
        modified_on:
          $ref: '#/components/schemas/timestamp'
        name:
          $ref: '#/components/schemas/waitingroom_components-schemas-name'
        new_users_per_minute:
          $ref: '#/components/schemas/new_users_per_minute'
        next_event_prequeue_start_time:
          $ref: '#/components/schemas/next_event_prequeue_start_time'
        next_event_start_time:
          $ref: '#/components/schemas/next_event_start_time'
        path:
          $ref: '#/components/schemas/schemas-path'
        queue_all:
          $ref: '#/components/schemas/queue_all'
        queueing_method:
          $ref: '#/components/schemas/queueing_method'
        session_duration:
          $ref: '#/components/schemas/schemas-session_duration'
        suspended:
          $ref: '#/components/schemas/schemas-suspended'
        total_active_users:
          $ref: '#/components/schemas/total_active_users'
    waitingroom_components-schemas-description:
      type: string
      description: A note that you can use to add more details about the waiting room.
      default: ""
      example: Production - DO NOT MODIFY
    waitingroom_components-schemas-name:
      type: string
      description: A unique name to identify the waiting room. Only alphanumeric characters,
        hyphens and underscores are allowed.
      example: production_webinar
    waitingroom_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/waitingroom'
    waitingroom_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/waitingroom'
    waitingroom_components-schemas-status:
      type: string
      enum:
      - event_prequeueing
      - not_queueing
      - queueing
      example: queueing
    warp_props:
      allOf:
      - $ref: '#/components/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
    wasm_module_binding:
      type: object
      required:
      - name
      - type
      properties:
        name:
          $ref: '#/components/schemas/binding_name'
        type:
          type: string
          description: The class of resource that the binding provides.
          enum:
          - wasm_module
          example: wasm_module
    watermark_at_upload:
      type: object
      properties:
        uid:
          type: string
          description: The unique identifier for the watermark profile.
          example: ea95132c15732412d22c1476fa83f27a
          maxLength: 32
    watermark_basic_upload:
      type: object
      required:
      - file
      properties:
        file:
          type: string
          description: The image file to upload.
          example: '@/Users/rchen/Downloads/watermark.png'
        name:
          $ref: '#/components/schemas/watermarks_components-schemas-name'
        opacity:
          $ref: '#/components/schemas/opacity'
        padding:
          $ref: '#/components/schemas/padding'
        position:
          $ref: '#/components/schemas/position'
        scale:
          $ref: '#/components/schemas/scale'
    watermark_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/watermarks'
    watermark_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    watermarkAtUpload:
      type: object
      properties:
        uid:
          type: string
          description: The unique identifier for the watermark profile.
          example: ea95132c15732412d22c1476fa83f27a
          maxLength: 32
    watermarks:
      type: object
      properties:
        created:
          $ref: '#/components/schemas/components-schemas-created'
        downloadedFrom:
          $ref: '#/components/schemas/downloadedFrom'
        height:
          $ref: '#/components/schemas/height'
        name:
          $ref: '#/components/schemas/watermarks_components-schemas-name'
        opacity:
          $ref: '#/components/schemas/opacity'
        padding:
          $ref: '#/components/schemas/padding'
        position:
          $ref: '#/components/schemas/position'
        scale:
          $ref: '#/components/schemas/scale'
        size:
          $ref: '#/components/schemas/schemas-size'
        uid:
          $ref: '#/components/schemas/watermarks_components-schemas-identifier'
        width:
          $ref: '#/components/schemas/width'
    watermarks_components-schemas-identifier:
      type: string
      description: The unique identifier for a watermark profile.
      example: ea95132c15732412d22c1476fa83f27a
      readOnly: true
      maxLength: 32
    watermarks_components-schemas-name:
      type: string
      description: A short description of the watermark profile.
      default: ""
      example: Marketing Videos
      readOnly: true
    web3-hostname:
      type: object
      properties:
        created_on:
          $ref: '#/components/schemas/timestamp'
        description:
          $ref: '#/components/schemas/web3-hostname_components-schemas-description'
        dnslink:
          $ref: '#/components/schemas/dnslink'
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        modified_on:
          $ref: '#/components/schemas/timestamp'
        name:
          $ref: '#/components/schemas/web3-hostname_components-schemas-name'
        status:
          $ref: '#/components/schemas/web3-hostname_components-schemas-status'
        target:
          $ref: '#/components/schemas/components-schemas-target'
    web3-hostname_components-schemas-description:
      type: string
      description: An optional description of the hostname.
      example: This is my IPFS gateway.
      maxLength: 500
    web3-hostname_components-schemas-name:
      type: string
      description: The hostname that will point to the target gateway via CNAME.
      example: gateway.example.com
      readOnly: true
      maxLength: 255
    web3-hostname_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/web3-hostname'
    web3-hostname_components-schemas-status:
      type: string
      description: Status of the hostname's activation.
      enum:
      - active
      - pending
      - deleting
      - error
      example: active
      readOnly: true
    webhook_components-schemas-account_identifier:
      type: string
      description: Account identifier tag.
      example: 023e105f4ecef8ad9ca31a8372d0c353
      readOnly: true
      maxLength: 32
    webhook_request:
      required:
      - notificationUrl
      properties:
        notificationUrl:
          $ref: '#/components/schemas/notificationUrl'
    webhook_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    webhooks:
      type: object
      properties:
        created_at:
          $ref: '#/components/schemas/webhooks_components-schemas-created_at'
        id:
          $ref: '#/components/schemas/uuid'
        last_failure:
          $ref: '#/components/schemas/last_failure'
        last_success:
          $ref: '#/components/schemas/last_success'
        name:
          $ref: '#/components/schemas/webhooks_components-schemas-name'
        secret:
          $ref: '#/components/schemas/schemas-secret'
        type:
          $ref: '#/components/schemas/webhooks_components-schemas-type'
        url:
          $ref: '#/components/schemas/webhooks_components-schemas-url'
    webhooks_components-schemas-created_at:
      type: string
      format: date-time
      description: Timestamp of when the webhook destination was created.
      example: "2020-10-26T18:25:04.532316Z"
      readOnly: true
    webhooks_components-schemas-id_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
            properties:
              id:
                $ref: '#/components/schemas/uuid'
    webhooks_components-schemas-name:
      type: string
      description: The name of the webhook destination. This will be included in the
        request body when you receive a webhook notification.
      example: Slack Webhook
    webhooks_components-schemas-response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/webhooks'
    webhooks_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/webhooks'
    webhooks_components-schemas-type:
      type: string
      description: Type of webhook endpoint.
      enum:
      - slack
      - generic
      - gchat
      example: slack
    webhooks_components-schemas-url:
      type: string
      description: The POST endpoint to call when dispatching a notification.
      example: https://hooks.slack.com/services/Ds3fdBFbV/456464Gdd
    webp:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - webp
            example: webp
          value:
            $ref: '#/components/schemas/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.
    webp_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "off"
      - "on"
      default: "off"
    websockets:
      allOf:
      - $ref: '#/components/schemas/schemas-base'
      - properties:
          id:
            description: ID of the zone setting.
            enum:
            - websockets
            example: websockets
          value:
            $ref: '#/components/schemas/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-).
    websockets_value:
      type: string
      description: Value of the zone setting.
      enum:
      - "off"
      - "on"
      default: "off"
    weight:
      type: number
      description: The weight of this origin relative to other origins in the pool.
        Based on the configured weight the total traffic is distributed among origins
        within the pool.
      default: 1
      example: 0.6
      minimum: 0
      maximum: 1
      multipleOf: 0.01
    whois:
      properties:
        created_date:
          type: string
          format: date
          example: "2009-02-17"
        domain:
          $ref: '#/components/schemas/schemas-domain_name'
        nameservers:
          type: array
          example:
          - ns3.cloudflare.com
          - ns4.cloudflare.com
          - ns5.cloudflare.com
          - ns6.cloudflare.com
          - ns7.cloudflare.com
          items:
            type: string
        registrant:
          type: string
          example: DATA REDACTED
        registrant_country:
          type: string
          example: United States
        registrant_email:
          type: string
          example: https://domaincontact.cloudflareregistrar.com/cloudflare.com
        registrant_org:
          type: string
          example: DATA REDACTED
        registrar:
          type: string
          example: Cloudflare, Inc.
        updated_date:
          type: string
          format: date
          example: "2017-05-24"
    whois_components-schemas-single_response:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            $ref: '#/components/schemas/whois'
    width:
      type: integer
      description: The width of the image in pixels.
      readOnly: true
    workspace_one_config_request:
      type: object
      required:
      - api_url
      - auth_url
      - client_id
      - client_secret
      properties:
        api_url:
          type: string
          description: The Workspace One API URL provided in the Workspace One Admin
            Dashboard.
          example: https://as123.awmdm.com/API
        auth_url:
          type: string
          description: The Workspace One Authorization URL depending on your region.
          example: https://na.uemauth.vmwservices.com/connect/token
        client_id:
          type: string
          description: The Workspace One client ID provided in the Workspace One Admin
            Dashboard.
          example: example client id
        client_secret:
          type: string
          description: The Workspace One client secret provided in the Workspace One
            Admin Dashboard.
          example: example client secret
    workspace_one_config_response:
      type: object
      description: The Workspace One Config Response.
      required:
      - api_url
      - auth_url
      - client_id
      properties:
        api_url:
          type: string
          description: The Workspace One API URL provided in the Workspace One Admin
            Dashboard.
          example: https://as123.awmdm.com/API
        auth_url:
          type: string
          description: The Workspace One Authorization URL depending on your region.
          example: https://na.uemauth.vmwservices.com/connect/token
        client_id:
          type: string
          description: The Workspace One client ID provided in the Workspace One Admin
            Dashboard.
          example: example client id
    zipcode:
      type: string
      description: The zipcode or postal code where the user lives.
      example: "12345"
      nullable: true
      maxLength: 20
    zone:
      type: object
      description: A simple zone object. May have null properties if not a zone subscription.
      properties:
        id:
          $ref: '#/components/schemas/common_components-schemas-identifier'
        name:
          $ref: '#/components/schemas/properties-name'
    zone-authenticated-origin-pull:
      allOf:
      - $ref: '#/components/schemas/certificateObject'
      type: object
      properties:
        certificate:
          $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate'
        enabled:
          $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled'
        id:
          $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier'
        private_key:
          $ref: '#/components/schemas/private_key'
    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-----
    zone-authenticated-origin-pull_components-schemas-enabled:
      type: boolean
      description: Indicates whether zone-level authenticated origin pulls is enabled.
      example: true
    zone-authenticated-origin-pull_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
    zone-authenticated-origin-pull_components-schemas-identifier:
      type: string
      description: Certificate identifier tag.
      example: 2458ce5a-0c35-4c7f-82c7-8e9487d3ff60
      readOnly: true
      maxLength: 36
    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
    zone_cache_settings_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    zone_components-schemas-zone:
      allOf:
      - $ref: '#/components/schemas/components-schemas-zone'
      type: object
    zone_identifier:
      description: Identifier of the zone.
      example: 593c9c94de529bbbfaac7c53ced0447d
    zone_metadata:
      type: object
      properties:
        enabled:
          type: boolean
          description: Whether zone uses account-level custom nameservers.
          example: true
    zone_name:
      type: string
      description: Name of the zone.
      example: example.com
    zone_settings_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - properties:
          result:
            anyOf:
            - type: array
              items: {}
            - type: object
            items:
              $ref: '#/components/schemas/setting'
    zone_settings_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - properties:
          result:
            type: object
    zone_subscription_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        properties:
          result:
            type: object
    zonelockdown:
      required:
      - id
      - created_on
      - modified_on
      - paused
      - description
      - urls
      - configurations
      properties:
        configurations:
          $ref: '#/components/schemas/configurations'
        created_on:
          $ref: '#/components/schemas/schemas-created_on'
        description:
          $ref: '#/components/schemas/lockdowns_components-schemas-description'
        id:
          $ref: '#/components/schemas/lockdowns_components-schemas-id'
        modified_on:
          $ref: '#/components/schemas/lockdowns_components-schemas-modified_on'
        paused:
          $ref: '#/components/schemas/components-schemas-paused'
        urls:
          $ref: '#/components/schemas/schemas-urls'
    zonelockdown_response_collection:
      allOf:
      - $ref: '#/components/schemas/api-response-collection'
      - type: object
        required:
        - result
        properties:
          result:
            type: array
            items:
              $ref: '#/components/schemas/zonelockdown'
    zonelockdown_response_single:
      allOf:
      - $ref: '#/components/schemas/api-response-single'
      - type: object
        required:
        - result
        properties:
          result:
            $ref: '#/components/schemas/zonelockdown'
    zones_connected:
      type: number
      description: The number of zones using this Railgun.
      example: 2
      readOnly: true
  securitySchemes:
    api_email:
      type: apiKey
      name: X-Auth-Email
      in: header
    api_key:
      type: apiKey
      name: X-Auth-Key
      in: header
    api_token:
      type: http
      scheme: bearer
    user_service_key:
      type: apiKey
      name: X-Auth-User-Service-Key
      in: header
info:
  title: Cloudflare API
  description: |-
    Interact with Cloudflare's products and services via the Cloudflare API.
    For more information on how to create and troubleshoot API tokens, refer to
    our [API fundamentals](https://developers.cloudflare.com/fundamentals/api/).

    Totally new to Cloudflare? [Start here](https://developers.cloudflare.com/fundamentals/get-started/).
  license:
    name: BSD-3-Clause
    url: https://opensource.org/licenses/BSD-3-Clause
  version: 4.0.0
paths:
  /accounts:
    get:
      tags:
      - Accounts
      summary: List Accounts
      description: List all accounts you have ownership or verified access to.
      operationId: accounts-list-accounts
      responses:
        4xx:
          description: List Accounts response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Accounts response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_id}/gateway/categories:
    get:
      tags:
      - Zero Trust Gateway Categories
      summary: List Categories
      description: List all Categories.
      operationId: zero-trust-gateway-categories-list-categories
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Categories response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/categories_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Categories response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/categories_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_id}/rulesets:
    get:
      tags:
      - Account Rulesets
      summary: List account rulesets
      description: Fetches all rulesets at the account level.
      operationId: account-rulesets-list-account-rulesets
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List account rulesets response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List account rulesets response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Account Rulesets
      summary: Create an account ruleset
      description: Creates a ruleset at the account level.
      operationId: account-rulesets-create-an-account-ruleset
      parameters:
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_ruleset'
      responses:
        4xx:
          description: Create an account ruleset response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create an account ruleset response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_id}/rulesets/{ruleset_id}:
    delete:
      tags:
      - Account Rulesets
      summary: Delete an account ruleset
      description: Deletes all versions of an existing account ruleset.
      operationId: account-rulesets-delete-an-account-ruleset
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an account ruleset response failure
          content:
            application/json: {}
        "200":
          description: Delete an account ruleset response
          content:
            application/json: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Account Rulesets
      summary: Get an account ruleset
      description: Fetches the latest version of an account ruleset.
      operationId: account-rulesets-get-an-account-ruleset
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get an account ruleset response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an account ruleset response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Account Rulesets
      summary: Update an account ruleset
      description: Updates an account ruleset, creating a new version.
      operationId: account-rulesets-update-an-account-ruleset
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_ruleset'
      responses:
        4xx:
          description: Update an account ruleset response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an account ruleset response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_id}/rulesets/{ruleset_id}/rules:
    post:
      tags:
      - Account Rulesets
      summary: Create an account ruleset rule
      description: Adds a new rule to an account ruleset. The rule will be added to
        the end of the existing list of rules in the ruleset.
      operationId: account-rulesets-create-an-account-ruleset-rule
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_update_rule'
      responses:
        4xx:
          description: Create an account ruleset rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create an account ruleset rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_id}/rulesets/{ruleset_id}/rules/{rule_id}:
    delete:
      tags:
      - Account Rulesets
      summary: Delete an account ruleset rule
      description: Deletes an existing rule from an account ruleset.
      operationId: account-rulesets-delete-an-account-ruleset-rule
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-id'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an account ruleset rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an account ruleset rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Account Rulesets
      summary: Update an account ruleset rule
      description: Updates an existing rule in an account ruleset.
      operationId: account-rulesets-update-an-account-ruleset-rule
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-id'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_update_rule'
      responses:
        4xx:
          description: Update an account ruleset rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an account ruleset rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_id}/rulesets/{ruleset_id}/versions:
    get:
      tags:
      - Account Rulesets
      summary: List an account ruleset's versions
      description: Fetches the versions of an account ruleset.
      operationId: account-rulesets-list-an-account-ruleset'-s-versions
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List an account ruleset's versions response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List an account ruleset's versions response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}:
    delete:
      tags:
      - Account Rulesets
      summary: Delete an account ruleset version
      description: Deletes an existing version of an account ruleset.
      operationId: account-rulesets-delete-an-account-ruleset-version
      parameters:
      - name: ruleset_version
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/version'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an account ruleset version response failure
          content:
            application/json: {}
        "200":
          description: Delete an account ruleset version response
          content:
            application/json: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Account Rulesets
      summary: Get an account ruleset version
      description: Fetches a specific version of an account ruleset.
      operationId: account-rulesets-get-an-account-ruleset-version
      parameters:
      - name: ruleset_version
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/version'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get an account ruleset version response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an account ruleset version response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_id}/rulesets/{ruleset_id}/versions/{ruleset_version}/by_tag/{rule_tag}:
    get:
      tags:
      - Account Rulesets
      summary: List an account ruleset version's rules by tag
      description: Fetches the rules of a managed account ruleset version for a given
        tag.
      operationId: account-rulesets-list-an-account-ruleset-version'-s-rules-by-tag
      parameters:
      - name: rule_tag
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/category'
      - name: ruleset_version
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/version'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List an account ruleset version's rules by tag response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List an account ruleset version's rules by tag response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint:
    get:
      tags:
      - Account Rulesets
      summary: Get an account entry point ruleset
      description: Fetches the latest version of the account entry point ruleset for
        a given phase.
      operationId: account-rulesets-get-an-account-entry-point-ruleset
      parameters:
      - name: ruleset_phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/phase'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get an account entry point ruleset response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an account entry point ruleset response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Account Rulesets
      summary: Update an account entry point ruleset
      description: Updates an account entry point ruleset, creating a new version.
      operationId: account-rulesets-update-an-account-entry-point-ruleset
      parameters:
      - name: ruleset_phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/phase'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_ruleset'
      responses:
        4xx:
          description: Update an account entry point ruleset response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an account entry point ruleset response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions:
    get:
      tags:
      - Account Rulesets
      summary: List an account entry point ruleset's versions
      description: Fetches the versions of an account entry point ruleset.
      operationId: account-rulesets-list-an-account-entry-point-ruleset'-s-versions
      parameters:
      - name: ruleset_phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/phase'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List an account entry point ruleset's versions response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List an account entry point ruleset's versions response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}:
    get:
      tags:
      - Account Rulesets
      summary: Get an account entry point ruleset version
      description: Fetches a specific version of an account entry point ruleset.
      operationId: account-rulesets-get-an-account-entry-point-ruleset-version
      parameters:
      - name: ruleset_version
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/version'
      - name: ruleset_phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/phase'
      - name: account_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get an account entry point ruleset version response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an account entry point ruleset version response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/addressing/address_maps:
    get:
      tags:
      - IP Address Management Address Maps
      summary: List Address Maps
      description: List all address maps owned by the account.
      operationId: ip-address-management-address-maps-list-address-maps
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Address Maps response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/address-maps_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Address Maps response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/address-maps_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - IP Address Management Address Maps
      summary: Create Address Map
      description: Create a new address map under the account.
      operationId: ip-address-management-address-maps-create-address-map
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                description:
                  $ref: '#/components/schemas/address-maps_components-schemas-description'
      responses:
        4xx:
          description: Create Address Map response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/full_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Address Map response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/full_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}:
    delete:
      tags:
      - IP Address Management Address Maps
      summary: Delete Address Map
      description: Delete a particular address map owned by the account.
      operationId: ip-address-management-address-maps-delete-address-map
      parameters:
      - name: address_map_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Address Map response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Address Map response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - IP Address Management Address Maps
      summary: Address Map Details
      description: Show a particular address map owned by the account.
      operationId: ip-address-management-address-maps-address-map-details
      parameters:
      - name: address_map_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Address Map Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/full_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Address Map Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/full_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - IP Address Management Address Maps
      summary: Update Address Map
      description: Modify the description or default SNI for an address map owned
        by the account.
      operationId: ip-address-management-address-maps-update-address-map
      parameters:
      - name: address_map_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                default_sni:
                  $ref: '#/components/schemas/default_sni'
                description:
                  $ref: '#/components/schemas/address-maps_components-schemas-description'
      responses:
        4xx:
          description: Update Address Map response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/address-maps_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Address Map response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/address-maps_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}/ips/{ip_address}:
    delete:
      tags:
      - IP Address Management Address Maps
      summary: Remove an IP from an Address Map
      description: Remove an IP from a particular address map.
      operationId: ip-address-management-address-maps-remove-an-ip-from-an-address-map
      parameters:
      - name: ip_address
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/ip_address'
      - name: address_map_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Remove an IP from an Address Map response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Remove an IP from an Address Map response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - IP Address Management Address Maps
      summary: Add an IP to an Address Map
      description: Add an IP from a prefix owned by the account to a particular address
        map.
      operationId: ip-address-management-address-maps-add-an-ip-to-an-address-map
      parameters:
      - name: ip_address
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/ip_address'
      - name: address_map_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Add an IP to an Address Map response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add an IP to an Address Map response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/addressing/address_maps/{address_map_identifier}/zones/{zone_identifier}:
    delete:
      tags:
      - IP Address Management Address Maps
      summary: Remove a zone membership from an Address Map
      description: Remove a zone as a member of a particular address map.
      operationId: ip-address-management-address-maps-remove-a-zone-membership-from-an-address-map
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: address_map_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Remove a zone membership from an Address Map response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Remove a zone membership from an Address Map response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - IP Address Management Address Maps
      summary: Add a zone membership to an Address Map
      description: Add a zone as a member of a particular address map.
      operationId: ip-address-management-address-maps-add-a-zone-membership-to-an-address-map
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: address_map_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Add a zone membership to an Address Map response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add a zone membership to an Address Map response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/addressing/loa_documents:
    post:
      tags:
      - IP Address Management Prefixes
      summary: Upload LOA Document
      description: Submit LOA document (pdf format) under the account.
      operationId: ip-address-management-prefixes-upload-loa-document
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - loa_document
              properties:
                loa_document:
                  type: string
                  description: LOA document to upload.
                  example: '@document.pdf'
      responses:
        4xx:
          description: Upload LOA Document response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/loa_upload_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Upload LOA Document response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/loa_upload_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/addressing/loa_documents/{loa_document_identifier}/download:
    get:
      tags:
      - IP Address Management Prefixes
      summary: Download LOA Document
      description: Download specified LOA document under the account.
      operationId: ip-address-management-prefixes-download-loa-document
      parameters:
      - name: loa_document_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/loa_document_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Download LOA Document response failure
          content:
            application/json:
              schema:
                allOf:
                - {}
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Download LOA Document response
          content:
            application/json:
              schema: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/addressing/prefixes:
    get:
      tags:
      - IP Address Management Prefixes
      summary: List Prefixes
      description: List all prefixes owned by the account.
      operationId: ip-address-management-prefixes-list-prefixes
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Prefixes response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ipam-prefixes_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Prefixes response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipam-prefixes_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - IP Address Management Prefixes
      summary: Add Prefix
      description: Add a prefix under the account.
      operationId: ip-address-management-prefixes-add-prefix
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - cidr
              - loa_document_id
              properties:
                asn:
                  $ref: '#/components/schemas/asn'
                cidr:
                  $ref: '#/components/schemas/cidr'
                loa_document_id:
                  $ref: '#/components/schemas/loa_document_identifier'
      responses:
        4xx:
          description: Add Prefix response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ipam-prefixes_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add Prefix response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipam-prefixes_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}:
    delete:
      tags:
      - IP Address Management Prefixes
      summary: Delete Prefix
      description: Delete an unapproved prefix owned by the account.
      operationId: ip-address-management-prefixes-delete-prefix
      parameters:
      - name: prefix_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Prefix response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Prefix response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - IP Address Management Prefixes
      summary: Prefix Details
      description: List a particular prefix owned by the account.
      operationId: ip-address-management-prefixes-prefix-details
      parameters:
      - name: prefix_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Prefix Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ipam-prefixes_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Prefix Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipam-prefixes_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - IP Address Management Prefixes
      summary: Update Prefix Description
      description: Modify the description for a prefix owned by the account.
      operationId: ip-address-management-prefixes-update-prefix-description
      parameters:
      - name: prefix_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - description
              properties:
                description:
                  $ref: '#/components/schemas/ipam-prefixes_components-schemas-description'
      responses:
        4xx:
          description: Update Prefix Description response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ipam-prefixes_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Prefix Description response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipam-prefixes_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/bgp/status:
    get:
      tags:
      - IP Address Management Dynamic Advertisement
      summary: Get Advertisement Status
      description: List the current advertisement state for a prefix.
      operationId: ip-address-management-dynamic-advertisement-get-advertisement-status
      parameters:
      - name: prefix_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Advertisement Status response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/advertised_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Advertisement Status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/advertised_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - IP Address Management Dynamic Advertisement
      summary: Update Prefix Dynamic Advertisement Status
      description: Advertise or withdraw BGP route for a prefix.
      operationId: ip-address-management-dynamic-advertisement-update-prefix-dynamic-advertisement-status
      parameters:
      - name: prefix_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - advertised
              properties:
                advertised:
                  $ref: '#/components/schemas/schemas-advertised'
      responses:
        4xx:
          description: Update Prefix Dynamic Advertisement Status response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/advertised_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Prefix Dynamic Advertisement Status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/advertised_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/delegations:
    get:
      tags:
      - IP Address Management Prefix Delegation
      summary: List Prefix Delegations
      description: List all delegations for a given account IP prefix.
      operationId: ip-address-management-prefix-delegation-list-prefix-delegations
      parameters:
      - name: prefix_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Prefix Delegations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ipam-delegations_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Prefix Delegations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipam-delegations_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - IP Address Management Prefix Delegation
      summary: Create Prefix Delegation
      description: Create a new account delegation for a given IP prefix.
      operationId: ip-address-management-prefix-delegation-create-prefix-delegation
      parameters:
      - name: prefix_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - cidr
              - delegated_account_id
              properties:
                cidr:
                  $ref: '#/components/schemas/cidr'
                delegated_account_id:
                  $ref: '#/components/schemas/delegated_account_identifier'
      responses:
        4xx:
          description: Create Prefix Delegation response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ipam-delegations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Prefix Delegation response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipam-delegations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/addressing/prefixes/{prefix_identifier}/delegations/{delegation_identifier}:
    delete:
      tags:
      - IP Address Management Prefix Delegation
      summary: Delete Prefix Delegation
      description: Delete an account delegation for a given IP prefix.
      operationId: ip-address-management-prefix-delegation-delete-prefix-delegation
      parameters:
      - name: delegation_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/delegation_identifier'
      - name: prefix_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Prefix Delegation response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ipam-delegations_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Prefix Delegation response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ipam-delegations_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/audit_logs:
    get:
      tags:
      - Audit Logs
      summary: Get account audit logs
      description: Gets a list of audit logs for an account. The list can be filtered
        by who made the change, which zone was the change made on, and the timeframe
        of the change.
      operationId: audit-logs-get-account-audit-logs
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get account audit logs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/audit_logs_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get account audit logs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/audit_logs_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/billing/profile:
    get:
      tags:
      - Account Billing Profile
      summary: Billing Profile Details
      description: Gets the current billing profile for the account.
      operationId: account-billing-profile-billing-profile-details
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      responses:
        4xx:
          description: Billing Profile Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billing_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Billing Profile Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/billing_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/brand-protection/submit:
    post:
      tags:
      - Phishing URL Scanner
      summary: Submit suspicious URL for scanning
      operationId: phishing-url-scanner-submit-suspicious-url-for-scanning
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/url_param'
              type: object
      responses:
        4xx:
          description: Submit suspicious URL for scanning response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/phishing-url-submit_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Submit suspicious URL for scanning response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/phishing-url-submit_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/brand-protection/url-info:
    get:
      tags:
      - Phishing URL Information
      summary: Get results for a URL scan
      operationId: phishing-url-information-get-results-for-a-url-scan
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get results for a URL scan response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/phishing-url-info_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get results for a URL scan response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/phishing-url-info_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/cfd_tunnel:
    get:
      tags:
      - Cloudflare Tunnel
      summary: List Cloudflare Tunnels
      description: Lists and filters Cloudflare Tunnels in an account.
      operationId: cloudflare-tunnel-list-cloudflare-tunnels
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      responses:
        4xx:
          description: List Cloudflare Tunnels response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-tunnel_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Cloudflare Tunnels response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-tunnel_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Cloudflare Tunnel
      summary: Create a Cloudflare Tunnel
      description: Creates a new Cloudflare Tunnel in an account.
      operationId: cloudflare-tunnel-create-a-cloudflare-tunnel
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - tunnel_secret
              properties:
                config_src:
                  $ref: '#/components/schemas/config_src'
                name:
                  $ref: '#/components/schemas/tunnel_name'
                tunnel_secret:
                  $ref: '#/components/schemas/tunnel_secret'
      responses:
        4xx:
          description: Create a Cloudflare Tunnel response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-tunnel_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a Cloudflare Tunnel response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-tunnel_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/cfd_tunnel/{tunnel_id}:
    delete:
      tags:
      - Cloudflare Tunnel
      summary: Delete a Cloudflare Tunnel
      description: Deletes a Cloudflare Tunnel from an account.
      operationId: cloudflare-tunnel-delete-a-cloudflare-tunnel
      parameters:
      - name: tunnel_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        4xx:
          description: Delete a Cloudflare Tunnel response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-tunnel_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a Cloudflare Tunnel response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-tunnel_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Cloudflare Tunnel
      summary: Get a Cloudflare Tunnel
      description: Fetches a single Cloudflare Tunnel.
      operationId: cloudflare-tunnel-get-a-cloudflare-tunnel
      parameters:
      - name: tunnel_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      responses:
        4xx:
          description: Get a Cloudflare Tunnel response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-tunnel_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a Cloudflare Tunnel response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-tunnel_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Cloudflare Tunnel
      summary: Update a Cloudflare Tunnel
      description: Updates an existing Cloudflare Tunnel.
      operationId: cloudflare-tunnel-update-a-cloudflare-tunnel
      parameters:
      - name: tunnel_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  $ref: '#/components/schemas/tunnel_name'
                tunnel_secret:
                  $ref: '#/components/schemas/tunnel_secret'
      responses:
        4xx:
          description: Update a Cloudflare Tunnel response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-tunnel_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a Cloudflare Tunnel response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-tunnel_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/configurations:
    get:
      tags:
      - Cloudflare Tunnel configuration
      summary: Get configuration
      description: Gets the configuration for a remotely-managed tunnel
      operationId: cloudflare-tunnel-configuration-get-configuration
      parameters:
      - name: tunnel_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/config_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/config_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Cloudflare Tunnel configuration
      summary: Put configuration
      description: Adds or updates the configuration for a remotely-managed tunnel.
      operationId: cloudflare-tunnel-configuration-put-configuration
      parameters:
      - name: tunnel_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                config:
                  $ref: '#/components/schemas/components-schemas-config'
      responses:
        4xx:
          description: Put configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/config_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Put configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/config_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/connections:
    delete:
      tags:
      - Cloudflare Tunnel
      summary: Clean up Cloudflare Tunnel connections
      description: Removes connections that are in a disconnected or pending reconnect
        state. We recommend running this command after shutting down a tunnel.
      operationId: cloudflare-tunnel-clean-up-cloudflare-tunnel-connections
      parameters:
      - name: tunnel_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        4xx:
          description: Clean up Cloudflare Tunnel connections response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-empty_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Clean up Cloudflare Tunnel connections response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cloudflare-tunnel_components-schemas-empty_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Cloudflare Tunnel
      summary: List Cloudflare Tunnel connections
      description: Fetches connection details for a Cloudflare Tunnel.
      operationId: cloudflare-tunnel-list-cloudflare-tunnel-connections
      parameters:
      - name: tunnel_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      responses:
        4xx:
          description: List Cloudflare Tunnel connections response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_connections_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Cloudflare Tunnel connections response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_connections_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/cfd_tunnel/{tunnel_id}/token:
    get:
      tags:
      - Cloudflare Tunnel
      summary: Get a Cloudflare Tunnel token
      description: Gets the token used to associate cloudflared with a specific tunnel.
      operationId: cloudflare-tunnel-get-a-cloudflare-tunnel-token
      parameters:
      - name: tunnel_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      responses:
        4xx:
          description: Get a Cloudflare Tunnel token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_response_token'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a Cloudflare Tunnel token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_response_token'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/custom_pages:
    get:
      tags:
      - Custom pages for an account
      summary: List custom pages
      description: Fetches all the custom pages at the account level.
      operationId: custom-pages-for-an-account-list-custom-pages
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List custom pages response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom_pages_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List custom pages response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_pages_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/custom_pages/{identifier}:
    get:
      tags:
      - Custom pages for an account
      summary: Get a custom page
      description: Fetches the details of a custom page.
      operationId: custom-pages-for-an-account-get-a-custom-page
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-pages_components-schemas-identifier-2'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a custom page response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom_pages_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a custom page response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_pages_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Custom pages for an account
      summary: Update a custom page
      description: Updates the configuration of an existing custom page.
      operationId: custom-pages-for-an-account-update-a-custom-page
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-pages_components-schemas-identifier-2'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - url
              - state
              properties:
                state:
                  $ref: '#/components/schemas/components-schemas-state'
                url:
                  $ref: '#/components/schemas/url'
      responses:
        4xx:
          description: Update a custom page response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom_pages_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a custom page response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_pages_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/diagnostics/traceroute:
    post:
      tags:
      - Diagnostics
      summary: Traceroute
      description: Run traceroutes from Cloudflare colos.
      operationId: diagnostics-traceroute
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - targets
              properties:
                colos:
                  $ref: '#/components/schemas/colos'
                options:
                  $ref: '#/components/schemas/schemas-options'
                targets:
                  $ref: '#/components/schemas/schemas-targets'
      responses:
        4xx:
          description: Traceroute response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/traceroute_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Traceroute response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/traceroute_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/dlp/patterns/validate:
    post:
      tags:
      - DLP Pattern Validation
      summary: Validate pattern
      description: Validates whether this pattern is a valid regular expression. Rejects
        it if the regular expression is too complex or can match an unbounded-length
        string. Your regex will be rejected if it uses the Kleene Star -- be sure
        to bound the maximum number of characters that can be matched.
      operationId: dlp-pattern-validation-validate-pattern
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/validate_pattern'
      responses:
        4xx:
          description: Validate pattern response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-validate_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Validate pattern response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-validate_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/dlp/profiles:
    get:
      tags:
      - DLP Profiles
      summary: List all profiles
      description: Lists all DLP profiles in an account.
      operationId: dlp-profiles-list-all-profiles
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List all profiles response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/profiles_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List all profiles response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/profiles_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/dlp/profiles/{profile_id}:
    get:
      tags:
      - DLP Profiles
      summary: Get DLP Profile
      description: Fetches a DLP profile by ID. Supports both predefined and custom
        profiles
      operationId: dlp-profiles-get-dlp-profile
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/profile_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get DLP Profile response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/either_profile_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get DLP Profile response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/either_profile_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/dlp/profiles/custom:
    post:
      tags:
      - DLP Profiles
      summary: Create custom profiles
      description: Creates a set of DLP custom profiles.
      operationId: dlp-profiles-create-custom-profiles
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_custom_profiles'
      responses:
        4xx:
          description: Create custom profiles response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/create_custom_profile_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create custom profiles response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/create_custom_profile_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/dlp/profiles/custom/{profile_id}:
    delete:
      tags:
      - DLP Profiles
      summary: Delete custom profile
      description: Deletes a DLP custom profile.
      operationId: dlp-profiles-delete-custom-profile
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/profile_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete custom profile response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete custom profile response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - DLP Profiles
      summary: Get custom profile
      description: Fetches a custom DLP profile.
      operationId: dlp-profiles-get-custom-profile
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/profile_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get custom profile response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom_profile_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get custom profile response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_profile_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - DLP Profiles
      summary: Update custom profile
      description: Updates a DLP custom profile.
      operationId: dlp-profiles-update-custom-profile
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/profile_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_custom_profile'
      responses:
        4xx:
          description: Update custom profile response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom_profile'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update custom profile response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_profile'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/dlp/profiles/predefined/{profile_id}:
    get:
      tags:
      - DLP Profiles
      summary: Get predefined profile
      description: Fetches a predefined DLP profile.
      operationId: dlp-profiles-get-predefined-profile
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/profile_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get predefined profile response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/predefined_profile_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get predefined profile response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/predefined_profile_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - DLP Profiles
      summary: Update predefined profile
      description: Updates a DLP predefined profile. Only supports enabling/disabling
        entries.
      operationId: dlp-profiles-update-predefined-profile
      parameters:
      - name: profile_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/profile_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_predefined_profile'
      responses:
        4xx:
          description: Update predefined profile response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/predefined_profile'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update predefined profile response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/predefined_profile'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/dns_firewall:
    get:
      tags:
      - DNS Firewall
      summary: List DNS Firewall Clusters
      description: List configured DNS Firewall clusters for an account.
      operationId: dns-firewall-list-dns-firewall-clusters
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List DNS Firewall Clusters response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_firewall_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List DNS Firewall Clusters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns_firewall_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - DNS Firewall
      summary: Create DNS Firewall Cluster
      description: Create a configured DNS Firewall Cluster.
      operationId: dns-firewall-create-dns-firewall-cluster
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - origin_ips
              properties:
                deprecate_any_requests:
                  $ref: '#/components/schemas/deprecate_any_requests'
                ecs_fallback:
                  $ref: '#/components/schemas/ecs_fallback'
                maximum_cache_ttl:
                  $ref: '#/components/schemas/maximum_cache_ttl'
                minimum_cache_ttl:
                  $ref: '#/components/schemas/minimum_cache_ttl'
                name:
                  $ref: '#/components/schemas/dns-firewall_components-schemas-name'
                negative_cache_ttl:
                  $ref: '#/components/schemas/negative_cache_ttl'
                origin_ips:
                  $ref: '#/components/schemas/origin_ips'
                ratelimit:
                  $ref: '#/components/schemas/ratelimit'
      responses:
        4xx:
          description: Create DNS Firewall Cluster response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_firewall_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create DNS Firewall Cluster response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns_firewall_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/dns_firewall/{identifier}:
    delete:
      tags:
      - DNS Firewall
      summary: Delete DNS Firewall Cluster
      description: Delete a configured DNS Firewall Cluster.
      operationId: dns-firewall-delete-dns-firewall-cluster
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete DNS Firewall Cluster response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/common_components-schemas-identifier'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete DNS Firewall Cluster response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/common_components-schemas-identifier'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - DNS Firewall
      summary: DNS Firewall Cluster Details
      description: Show a single configured DNS Firewall cluster for an account.
      operationId: dns-firewall-dns-firewall-cluster-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: DNS Firewall Cluster Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_firewall_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: DNS Firewall Cluster Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns_firewall_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - DNS Firewall
      summary: Update DNS Firewall Cluster
      description: Modify a DNS Firewall Cluster configuration.
      operationId: dns-firewall-update-dns-firewall-cluster
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas-dns-firewall'
      responses:
        4xx:
          description: Update DNS Firewall Cluster response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_firewall_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update DNS Firewall Cluster response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns_firewall_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report:
    get:
      tags:
      - DNS Firewall Analytics
      summary: Table
      description: Retrieves a list of summarised aggregate metrics over a given time
        period.
      operationId: dns-firewall-analytics-table
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Table response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - type: object
                    properties:
                      result:
                        $ref: '#/components/schemas/result'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Table response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/result'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/dns_firewall/{identifier}/dns_analytics/report/bytime:
    get:
      tags:
      - DNS Firewall Analytics
      summary: By Time
      description: Retrieves a list of aggregate metrics grouped by time interval.
      operationId: dns-firewall-analytics-by-time
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: By Time response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - type: object
                    properties:
                      result:
                        $ref: '#/components/schemas/result'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: By Time response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/result'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/email/routing/addresses:
    get:
      tags:
      - Email Routing destination addresses
      summary: List destination addresses
      description: Lists existing destination addresses.
      operationId: email-routing-destination-addresses-list-destination-addresses
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List destination addresses response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/destination_addresses_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List destination addresses response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/destination_addresses_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Email Routing destination addresses
      summary: Create a destination address
      description: Create a destination address to forward your emails to. Destination
        addresses need to be verified before they can be used.
      operationId: email-routing-destination-addresses-create-a-destination-address
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_destination_address_properties'
      responses:
        4xx:
          description: Create a destination address response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/destination_address_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a destination address response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/destination_address_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/email/routing/addresses/{destination_address_identifier}:
    delete:
      tags:
      - Email Routing destination addresses
      summary: Delete destination address
      description: Deletes a specific destination address.
      operationId: email-routing-destination-addresses-delete-destination-address
      parameters:
      - name: destination_address_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/destination_address_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete destination address response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/destination_address_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete destination address response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/destination_address_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Email Routing destination addresses
      summary: Get a destination address
      description: Gets information for a specific destination email already created.
      operationId: email-routing-destination-addresses-get-a-destination-address
      parameters:
      - name: destination_address_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/destination_address_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a destination address response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/destination_address_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a destination address response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/destination_address_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/firewall/access_rules/rules:
    get:
      tags:
      - IP Access rules for an account
      summary: List IP Access rules
      description: Fetches IP Access rules of an account. These rules apply to all
        the zones in the account. You can filter the results using several optional
        parameters.
      operationId: ip-access-rules-for-an-account-list-ip-access-rules
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      responses:
        4xx:
          description: List IP Access rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List IP Access rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - IP Access rules for an account
      summary: Create an IP Access rule
      description: |-
        Creates a new IP Access rule for an account. The rule will apply to all zones in the account.

        Note: To create an IP Access rule that applies to a single zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.
      operationId: ip-access-rules-for-an-account-create-an-ip-access-rule
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - mode
              - configuration
              properties:
                configuration:
                  $ref: '#/components/schemas/schemas-configuration'
                mode:
                  $ref: '#/components/schemas/schemas-mode'
                notes:
                  $ref: '#/components/schemas/notes'
      responses:
        4xx:
          description: Create an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/firewall/access_rules/rules/{identifier}:
    delete:
      tags:
      - IP Access rules for an account
      summary: Delete an IP Access rule
      description: |-
        Deletes an existing IP Access rule defined at the account level.

        Note: This operation will affect all zones in the account.
      operationId: ip-access-rules-for-an-account-delete-an-ip-access-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - IP Access rules for an account
      summary: Get an IP Access rule
      description: Fetches the details of an IP Access rule defined at the account
        level.
      operationId: ip-access-rules-for-an-account-get-an-ip-access-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      responses:
        4xx:
          description: Get an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - IP Access rules for an account
      summary: Update an IP Access rule
      description: |-
        Updates an IP Access rule defined at the account level.

        Note: This operation will affect all zones in the account.
      operationId: ip-access-rules-for-an-account-update-an-ip-access-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas-rule'
      responses:
        4xx:
          description: Update an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/images/v1:
    get:
      tags:
      - Cloudflare Images
      summary: List images
      description: List up to 100 images with one request. Use the optional parameters
        below to get a specific range of images.
      operationId: cloudflare-images-list-images
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-account_identifier'
      responses:
        4xx:
          description: List images response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/image_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List images response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/image_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Cloudflare Images
      summary: Upload an image via URL
      description: Upload an image via URL with up to 10 Megabytes using a single
        HTTP POST (multipart/form-data) request.
      operationId: cloudflare-images-upload-an-image-via-url
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/image_basic_upload_via_url'
      responses:
        4xx:
          description: Upload an image via URL response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/image_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Upload an image via URL response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/image_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/images/v1/{identifier}:
    delete:
      tags:
      - Cloudflare Images
      summary: Delete image
      description: Delete an image on Cloudflare Images. On success, all copies of
        the image are deleted and purged from cache.
      operationId: cloudflare-images-delete-image
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete image response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-deleted_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete image response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-deleted_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Cloudflare Images
      summary: Image details
      description: Fetch details for a single image.
      operationId: cloudflare-images-image-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-account_identifier'
      responses:
        4xx:
          description: Image details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/image_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Image details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/image_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Cloudflare Images
      summary: Update image
      description: Update image access control. On access control change, all copies
        of the image are purged from cache.
      operationId: cloudflare-images-update-image
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/image_patch_request'
      responses:
        4xx:
          description: Update image response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/image_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update image response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/image_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/images/v1/{identifier}/blob:
    get:
      tags:
      - Cloudflare Images
      summary: Base image
      description: Fetch base image. For most images this will be the originally uploaded
        file. For larger images it can be a near-lossless version of the original.
      operationId: cloudflare-images-base-image
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-account_identifier'
      responses:
        4xx:
          description: Base image response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/image_response_blob'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Base image response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/image_response_blob'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/images/v1/direct_upload:
    post:
      tags:
      - Cloudflare Images
      summary: Create authenticated direct upload URL
      description: Direct uploads allow users to upload images without API keys. A
        common use case are web apps, client-side applications, or mobile devices
        where users upload content directly to Cloudflare Images.
      operationId: cloudflare-images-create-authenticated-direct-upload-url
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas-direct_upload_request'
      responses:
        4xx:
          description: Create authenticated direct upload URL response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-direct_upload_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create authenticated direct upload URL response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-direct_upload_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/images/v1/keys:
    get:
      tags:
      - Cloudflare Images Keys
      summary: List Signing Keys
      description: Lists your signing keys. These can be found on your Cloudflare
        Images dashboard.
      operationId: cloudflare-images-keys-list-signing-keys
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Signing Keys response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-key_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Signing Keys response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-key_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/images/v1/stats:
    get:
      tags:
      - Cloudflare Images
      summary: Images usage statistics
      description: Fetch usage statistics details for Cloudflare Images.
      operationId: cloudflare-images-images-usage-statistics
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-account_identifier'
      responses:
        4xx:
          description: Images usage statistics response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/images_stats'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Images usage statistics response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/images_stats'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/images/v1/variants:
    get:
      tags:
      - Cloudflare Images Variants
      summary: List variants
      description: Lists existing variants.
      operationId: cloudflare-images-variants-list-variants
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List variants response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/variant_list_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List variants response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/variant_list_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Cloudflare Images Variants
      summary: Create a variant
      description: Specify variants that allow you to resize images for different
        use cases.
      operationId: cloudflare-images-variants-create-a-variant
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/variant_generation_request'
      responses:
        4xx:
          description: Create a variant response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/variant_simple_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a variant response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/variant_simple_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/images/v1/variants/{identifier}:
    delete:
      tags:
      - Cloudflare Images Variants
      summary: Delete a variant
      description: Deleting a variant purges the cache for all images associated with
        the variant.
      operationId: cloudflare-images-variants-delete-a-variant
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/variants_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a variant response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-deleted_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a variant response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-deleted_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Cloudflare Images Variants
      summary: Variant details
      description: Fetch details for a single variant.
      operationId: cloudflare-images-variants-variant-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/variants_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Variant details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/variant_simple_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Variant details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/variant_simple_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Cloudflare Images Variants
      summary: Update a variant
      description: Updating a variant purges the cache for all images associated with
        the variant.
      operationId: cloudflare-images-variants-update-a-variant
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/variants_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/variant_patch_request'
      responses:
        4xx:
          description: Update a variant response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/variant_simple_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a variant response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/variant_simple_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/images/v2/direct_upload:
    post:
      tags:
      - Cloudflare Images
      summary: Create authenticated direct upload URL V2
      description: 'Direct uploads allow users to upload images without API keys.
        A common use case are web apps, client-side applications, or mobile devices
        where users upload content directly to Cloudflare Images. This method creates
        a draft record for a future image. It returns an upload URL and an image identifier.
        To verify if the image itself has been uploaded, send an image details request
        (accounts/:account_identifier/images/v1/:identifier), and check that the `draft:
        true` property is not present.'
      operationId: cloudflare-images-create-authenticated-direct-upload-url-v-2
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/images_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/direct_upload_request_v2'
      responses:
        4xx:
          description: Create authenticated direct upload URL V2 response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/direct_upload_response_v2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create authenticated direct upload URL V2 response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/direct_upload_response_v2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/intel/asn/{asn}:
    get:
      tags:
      - ASN Intelligence
      summary: Get ASN Overview
      operationId: asn-intelligence-get-asn-overview
      parameters:
      - name: asn
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/asn_components-schemas-asn'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get ASN Overview response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/asn_components-schemas-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get ASN Overview response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/asn_components-schemas-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/intel/asn/{asn}/subnets:
    get:
      tags:
      - ASN Intelligence
      summary: Get ASN Subnets
      operationId: asn-intelligence-get-asn-subnets
      parameters:
      - name: asn
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/asn_components-schemas-asn'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get ASN Subnets response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    asn:
                      $ref: '#/components/schemas/components-schemas-asn'
                    count:
                      $ref: '#/components/schemas/schemas-count'
                    ip_count_total:
                      type: integer
                    page:
                      $ref: '#/components/schemas/page'
                    per_page:
                      $ref: '#/components/schemas/per_page'
                    subnets:
                      type: array
                      example:
                      - 192.0.2.0/24
                      - 2001:DB8::/32
                      items:
                        type: string
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get ASN Subnets response
          content:
            application/json:
              schema:
                type: object
                properties:
                  asn:
                    $ref: '#/components/schemas/components-schemas-asn'
                  count:
                    $ref: '#/components/schemas/schemas-count'
                  ip_count_total:
                    type: integer
                  page:
                    $ref: '#/components/schemas/page'
                  per_page:
                    $ref: '#/components/schemas/per_page'
                  subnets:
                    type: array
                    example:
                    - 192.0.2.0/24
                    - 2001:DB8::/32
                    items:
                      type: string
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/intel/dns:
    get:
      tags:
      - Passive DNS by IP
      summary: Get Passive DNS by IP
      operationId: passive-dns-by-ip-get-passive-dns-by-ip
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Passive DNS by IP response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/passive-dns-by-ip_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Passive DNS by IP response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/passive-dns-by-ip_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/intel/domain:
    get:
      tags:
      - Domain Intelligence
      summary: Get Domain Details
      operationId: domain-intelligence-get-domain-details
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Domain Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/domain_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Domain Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/intel/domain-history:
    get:
      tags:
      - Domain History
      summary: Get Domain History
      operationId: domain-history-get-domain-history
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Domain History response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Domain History response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/intel/domain/bulk:
    get:
      tags:
      - Domain Intelligence
      summary: Get Multiple Domain Details
      operationId: domain-intelligence-get-multiple-domain-details
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Multiple Domain Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Multiple Domain Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/intel/ip:
    get:
      tags:
      - IP Intelligence
      summary: Get IP Overview
      operationId: ip-intelligence-get-ip-overview
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get IP Overview response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get IP Overview response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/intel/ip-list:
    get:
      tags:
      - IP List
      summary: Get IP Lists
      operationId: ip-list-get-ip-lists
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get IP Lists response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get IP Lists response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/intel/miscategorization:
    post:
      tags:
      - Miscategorization
      summary: Create Miscategorization
      operationId: miscategorization-create-miscategorization
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/miscategorization'
      responses:
        4xx:
          description: Create Miscategorization response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Miscategorization response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/intel/whois:
    get:
      tags:
      - WHOIS Record
      summary: Get WHOIS Record
      operationId: whois-record-get-whois-record
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get WHOIS Record response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/whois_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get WHOIS Record response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/whois_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/monitors:
    get:
      tags:
      - Account Load Balancer Monitors
      summary: List Monitors
      description: List configured monitors for an account.
      operationId: account-load-balancer-monitors-list-monitors
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Monitors response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/monitor_components-schemas-response_collection-2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Monitors response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/monitor_components-schemas-response_collection-2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Account Load Balancer Monitors
      summary: Create Monitor
      description: Create a configured monitor.
      operationId: account-load-balancer-monitors-create-monitor
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - expected_codes
              properties:
                allow_insecure:
                  $ref: '#/components/schemas/allow_insecure'
                consecutive_down:
                  $ref: '#/components/schemas/consecutive_down'
                consecutive_up:
                  $ref: '#/components/schemas/consecutive_up'
                description:
                  $ref: '#/components/schemas/monitor_components-schemas-description'
                expected_body:
                  $ref: '#/components/schemas/expected_body'
                expected_codes:
                  $ref: '#/components/schemas/schemas-expected_codes'
                follow_redirects:
                  $ref: '#/components/schemas/follow_redirects'
                header:
                  $ref: '#/components/schemas/header'
                interval:
                  $ref: '#/components/schemas/interval'
                method:
                  $ref: '#/components/schemas/schemas-method'
                path:
                  $ref: '#/components/schemas/path'
                port:
                  $ref: '#/components/schemas/monitor_components-schemas-port'
                probe_zone:
                  $ref: '#/components/schemas/probe_zone'
                retries:
                  $ref: '#/components/schemas/retries'
                timeout:
                  $ref: '#/components/schemas/schemas-timeout'
                type:
                  $ref: '#/components/schemas/monitor_components-schemas-type'
      responses:
        4xx:
          description: Create Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/monitor_components-schemas-single_response-2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/monitor_components-schemas-single_response-2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/monitors/{identifier}:
    delete:
      tags:
      - Account Load Balancer Monitors
      summary: Delete Monitor
      description: Delete a configured monitor.
      operationId: account-load-balancer-monitors-delete-monitor
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/monitor_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/monitor_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Account Load Balancer Monitors
      summary: Monitor Details
      description: List a single configured monitor for an account.
      operationId: account-load-balancer-monitors-monitor-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Monitor Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/monitor_components-schemas-single_response-2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Monitor Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/monitor_components-schemas-single_response-2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Account Load Balancer Monitors
      summary: Patch Monitor
      description: Apply changes to an existing monitor, overwriting the supplied
        properties.
      operationId: account-load-balancer-monitors-patch-monitor
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                allow_insecure:
                  $ref: '#/components/schemas/allow_insecure'
                consecutive_down:
                  $ref: '#/components/schemas/consecutive_down'
                consecutive_up:
                  $ref: '#/components/schemas/consecutive_up'
                description:
                  $ref: '#/components/schemas/monitor_components-schemas-description'
                expected_body:
                  $ref: '#/components/schemas/expected_body'
                expected_codes:
                  $ref: '#/components/schemas/schemas-expected_codes'
                follow_redirects:
                  $ref: '#/components/schemas/follow_redirects'
                header:
                  $ref: '#/components/schemas/header'
                interval:
                  $ref: '#/components/schemas/interval'
                method:
                  $ref: '#/components/schemas/schemas-method'
                path:
                  $ref: '#/components/schemas/path'
                port:
                  $ref: '#/components/schemas/monitor_components-schemas-port'
                probe_zone:
                  $ref: '#/components/schemas/probe_zone'
                retries:
                  $ref: '#/components/schemas/retries'
                timeout:
                  $ref: '#/components/schemas/schemas-timeout'
                type:
                  $ref: '#/components/schemas/monitor_components-schemas-type'
      responses:
        4xx:
          description: Patch Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/monitor_components-schemas-single_response-2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/monitor_components-schemas-single_response-2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Account Load Balancer Monitors
      summary: Update Monitor
      description: Modify a configured monitor.
      operationId: account-load-balancer-monitors-update-monitor
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - expected_codes
              properties:
                allow_insecure:
                  $ref: '#/components/schemas/allow_insecure'
                consecutive_down:
                  $ref: '#/components/schemas/consecutive_down'
                consecutive_up:
                  $ref: '#/components/schemas/consecutive_up'
                description:
                  $ref: '#/components/schemas/monitor_components-schemas-description'
                expected_body:
                  $ref: '#/components/schemas/expected_body'
                expected_codes:
                  $ref: '#/components/schemas/schemas-expected_codes'
                follow_redirects:
                  $ref: '#/components/schemas/follow_redirects'
                header:
                  $ref: '#/components/schemas/header'
                interval:
                  $ref: '#/components/schemas/interval'
                method:
                  $ref: '#/components/schemas/schemas-method'
                path:
                  $ref: '#/components/schemas/path'
                port:
                  $ref: '#/components/schemas/monitor_components-schemas-port'
                probe_zone:
                  $ref: '#/components/schemas/probe_zone'
                retries:
                  $ref: '#/components/schemas/retries'
                timeout:
                  $ref: '#/components/schemas/schemas-timeout'
                type:
                  $ref: '#/components/schemas/monitor_components-schemas-type'
      responses:
        4xx:
          description: Update Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/monitor_components-schemas-single_response-2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/monitor_components-schemas-single_response-2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/monitors/{identifier}/preview:
    post:
      tags:
      - Account Load Balancer Monitors
      summary: Preview Monitor
      description: Preview pools using the specified monitor with provided monitor
        details. The returned preview_id can be used in the preview endpoint to retrieve
        the results.
      operationId: account-load-balancer-monitors-preview-monitor
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - expected_codes
              properties:
                allow_insecure:
                  $ref: '#/components/schemas/allow_insecure'
                expected_body:
                  $ref: '#/components/schemas/expected_body'
                expected_codes:
                  $ref: '#/components/schemas/schemas-expected_codes'
                follow_redirects:
                  $ref: '#/components/schemas/follow_redirects'
                header:
                  $ref: '#/components/schemas/header'
                method:
                  $ref: '#/components/schemas/schemas-method'
                path:
                  $ref: '#/components/schemas/path'
                port:
                  $ref: '#/components/schemas/monitor_components-schemas-port'
                probe_zone:
                  $ref: '#/components/schemas/probe_zone'
                retries:
                  $ref: '#/components/schemas/retries'
                timeout:
                  $ref: '#/components/schemas/schemas-timeout'
                type:
                  $ref: '#/components/schemas/monitor_components-schemas-type'
      responses:
        4xx:
          description: Preview Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/preview_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Preview Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/preview_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/monitors/{identifier}/references:
    get:
      tags:
      - Account Load Balancer Monitors
      summary: List Monitor References
      description: Get the list of resources that reference the provided monitor.
      operationId: account-load-balancer-monitors-list-monitor-references
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Monitor References response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/references_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Monitor References response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/references_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/pools:
    get:
      tags:
      - Account Load Balancer Pools
      summary: List Pools
      description: List configured pools.
      operationId: account-load-balancer-pools-list-pools
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Pools response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Pools response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Account Load Balancer Pools
      summary: Patch Pools
      description: Apply changes to a number of existing pools, overwriting the supplied
        properties. Pools are ordered by ascending `name`. Returns the list of affected
        pools. Supports the standard pagination query parameters, either `limit`/`offset`
        or `per_page`/`page`.
      operationId: account-load-balancer-pools-patch-pools
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                notification_email:
                  $ref: '#/components/schemas/patch_pools_notification_email'
      responses:
        4xx:
          description: Patch Pools response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch Pools response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Account Load Balancer Pools
      summary: Create Pool
      description: Create a new pool.
      operationId: account-load-balancer-pools-create-pool
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - origins
              - name
              properties:
                description:
                  $ref: '#/components/schemas/pool_components-schemas-description'
                enabled:
                  $ref: '#/components/schemas/pool_components-schemas-enabled'
                latitude:
                  $ref: '#/components/schemas/latitude'
                load_shedding:
                  $ref: '#/components/schemas/load_shedding'
                longitude:
                  $ref: '#/components/schemas/longitude'
                minimum_origins:
                  $ref: '#/components/schemas/minimum_origins'
                monitor:
                  $ref: '#/components/schemas/schemas-monitor'
                name:
                  $ref: '#/components/schemas/pool_components-schemas-name'
                notification_email:
                  $ref: '#/components/schemas/notification_email'
                notification_filter:
                  $ref: '#/components/schemas/notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/origin_steering'
                origins:
                  $ref: '#/components/schemas/origins'
      responses:
        4xx:
          description: Create Pool response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Pool response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/pools/{identifier}:
    delete:
      tags:
      - Account Load Balancer Pools
      summary: Delete Pool
      description: Delete a configured pool.
      operationId: account-load-balancer-pools-delete-pool
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Pool response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Pool response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Account Load Balancer Pools
      summary: Pool Details
      description: Fetch a single configured pool.
      operationId: account-load-balancer-pools-pool-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Pool Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Pool Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Account Load Balancer Pools
      summary: Patch Pool
      description: Apply changes to an existing pool, overwriting the supplied properties.
      operationId: account-load-balancer-pools-patch-pool
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                check_regions:
                  $ref: '#/components/schemas/check_regions'
                description:
                  $ref: '#/components/schemas/pool_components-schemas-description'
                disabled_at:
                  $ref: '#/components/schemas/schemas-disabled_at'
                enabled:
                  $ref: '#/components/schemas/pool_components-schemas-enabled'
                latitude:
                  $ref: '#/components/schemas/latitude'
                load_shedding:
                  $ref: '#/components/schemas/load_shedding'
                longitude:
                  $ref: '#/components/schemas/longitude'
                minimum_origins:
                  $ref: '#/components/schemas/minimum_origins'
                monitor:
                  $ref: '#/components/schemas/schemas-monitor'
                name:
                  $ref: '#/components/schemas/pool_components-schemas-name'
                notification_email:
                  $ref: '#/components/schemas/notification_email'
                notification_filter:
                  $ref: '#/components/schemas/notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/origin_steering'
                origins:
                  $ref: '#/components/schemas/origins'
      responses:
        4xx:
          description: Patch Pool response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch Pool response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Account Load Balancer Pools
      summary: Update Pool
      description: Modify a configured pool.
      operationId: account-load-balancer-pools-update-pool
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - origins
              - name
              properties:
                check_regions:
                  $ref: '#/components/schemas/check_regions'
                description:
                  $ref: '#/components/schemas/pool_components-schemas-description'
                disabled_at:
                  $ref: '#/components/schemas/schemas-disabled_at'
                enabled:
                  $ref: '#/components/schemas/pool_components-schemas-enabled'
                latitude:
                  $ref: '#/components/schemas/latitude'
                load_shedding:
                  $ref: '#/components/schemas/load_shedding'
                longitude:
                  $ref: '#/components/schemas/longitude'
                minimum_origins:
                  $ref: '#/components/schemas/minimum_origins'
                monitor:
                  $ref: '#/components/schemas/schemas-monitor'
                name:
                  $ref: '#/components/schemas/pool_components-schemas-name'
                notification_email:
                  $ref: '#/components/schemas/notification_email'
                notification_filter:
                  $ref: '#/components/schemas/notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/origin_steering'
                origins:
                  $ref: '#/components/schemas/origins'
      responses:
        4xx:
          description: Update Pool response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Pool response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/pools/{identifier}/health:
    get:
      tags:
      - Account Load Balancer Pools
      summary: Pool Health Details
      description: Fetch the latest pool health status for a single pool.
      operationId: account-load-balancer-pools-pool-health-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Pool Health Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/health_details'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Pool Health Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/health_details'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/pools/{identifier}/preview:
    post:
      tags:
      - Account Load Balancer Pools
      summary: Preview Pool
      description: Preview pool health using provided monitor details. The returned
        preview_id can be used in the preview endpoint to retrieve the results.
      operationId: account-load-balancer-pools-preview-pool
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - expected_codes
              properties:
                allow_insecure:
                  $ref: '#/components/schemas/allow_insecure'
                expected_body:
                  $ref: '#/components/schemas/expected_body'
                expected_codes:
                  $ref: '#/components/schemas/schemas-expected_codes'
                follow_redirects:
                  $ref: '#/components/schemas/follow_redirects'
                header:
                  $ref: '#/components/schemas/header'
                method:
                  $ref: '#/components/schemas/schemas-method'
                path:
                  $ref: '#/components/schemas/path'
                port:
                  $ref: '#/components/schemas/monitor_components-schemas-port'
                probe_zone:
                  $ref: '#/components/schemas/probe_zone'
                retries:
                  $ref: '#/components/schemas/retries'
                timeout:
                  $ref: '#/components/schemas/schemas-timeout'
                type:
                  $ref: '#/components/schemas/monitor_components-schemas-type'
      responses:
        4xx:
          description: Preview Pool response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/preview_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Preview Pool response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/preview_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/pools/{identifier}/references:
    get:
      tags:
      - Account Load Balancer Pools
      summary: List Pool References
      description: Get the list of resources that reference the provided pool.
      operationId: account-load-balancer-pools-list-pool-references
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Pool References response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-references_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Pool References response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-references_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/preview/{preview_id}:
    get:
      tags:
      - Account Load Balancer Monitors
      summary: Preview Result
      description: Get the result of a previous preview operation using the provided
        preview_id.
      operationId: account-load-balancer-monitors-preview-result
      parameters:
      - name: preview_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-preview_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Preview Result response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/preview_result_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Preview Result response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/preview_result_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/regions:
    get:
      tags:
      - Load Balancer Regions
      summary: List Regions
      description: List all region mappings.
      operationId: load-balancer-regions-list-regions
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Regions response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/region_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Regions response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/region_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/regions/{region_code}:
    get:
      tags:
      - Load Balancer Regions
      summary: Get Region
      description: Get a single region mapping.
      operationId: load-balancer-regions-get-region
      parameters:
      - name: region_code
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/region_code'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Region response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/region_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Region response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/region_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/load_balancers/search:
    get:
      tags:
      - Account Load Balancer Search
      summary: Search Resources
      description: Search for Load Balancing resources.
      operationId: account-load-balancer-search-search-resources
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Search Resources response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - $ref: '#/components/schemas/search_result'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Search Resources response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - $ref: '#/components/schemas/search_result'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/magic/cf_interconnects:
    get:
      tags:
      - Magic Interconnects
      summary: List interconnects
      description: Lists interconnects associated with an account.
      operationId: magic-interconnects-list-interconnects
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List interconnects response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-tunnels_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List interconnects response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-tunnels_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Magic Interconnects
      summary: Update multiple interconnects
      description: Updates multiple interconnects associated with an account. Use
        `?validate_only=true` as an optional query parameter to only run validation
        without persisting changes.
      operationId: magic-interconnects-update-multiple-interconnects
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        4xx:
          description: Update multiple interconnects response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-modified_tunnels_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update multiple interconnects response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-modified_tunnels_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/magic/cf_interconnects/{tunnel_identifier}:
    get:
      tags:
      - Magic Interconnects
      summary: List interconnect Details
      description: Lists details for a specific interconnect.
      operationId: magic-interconnects-list-interconnect-details
      parameters:
      - name: tunnel_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List interconnect Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-tunnel_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List interconnect Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-tunnel_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Magic Interconnects
      summary: Update interconnect
      description: Updates a specific interconnect associated with an account. Use
        `?validate_only=true` as an optional query parameter to only run validation
        without persisting changes.
      operationId: magic-interconnects-update-interconnect
      parameters:
      - name: tunnel_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/components-schemas-tunnel_update_request'
      responses:
        4xx:
          description: Update interconnect response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-tunnel_modified_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update interconnect response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-tunnel_modified_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/magic/gre_tunnels:
    get:
      tags:
      - Magic GRE tunnels
      summary: List GRE tunnels
      description: Lists GRE tunnels associated with an account.
      operationId: magic-gre-tunnels-list-gre-tunnels
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List GRE tunnels response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnels_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List GRE tunnels response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnels_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Magic GRE tunnels
      summary: Create GRE tunnels
      description: Creates new GRE tunnels. Use `?validate_only=true` as an optional
        query parameter to only run validation without persisting changes.
      operationId: magic-gre-tunnels-create-gre-tunnels
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - customer_gre_endpoint
              - cloudflare_gre_endpoint
              - interface_address
      responses:
        4xx:
          description: Create GRE tunnels response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnels_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create GRE tunnels response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnels_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Magic GRE tunnels
      summary: Update multiple GRE tunnels
      description: Updates multiple GRE tunnels. Use `?validate_only=true` as an optional
        query parameter to only run validation without persisting changes.
      operationId: magic-gre-tunnels-update-multiple-gre-tunnels
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        4xx:
          description: Update multiple GRE tunnels response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/modified_tunnels_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update multiple GRE tunnels response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/modified_tunnels_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/magic/gre_tunnels/{tunnel_identifier}:
    delete:
      tags:
      - Magic GRE tunnels
      summary: Delete GRE Tunnel
      description: Disables and removes a specific static GRE tunnel. Use `?validate_only=true`
        as an optional query parameter to only run validation without persisting changes.
      operationId: magic-gre-tunnels-delete-gre-tunnel
      parameters:
      - name: tunnel_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete GRE Tunnel response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_deleted_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete GRE Tunnel response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_deleted_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Magic GRE tunnels
      summary: List GRE Tunnel Details
      description: Lists informtion for a specific GRE tunnel.
      operationId: magic-gre-tunnels-list-gre-tunnel-details
      parameters:
      - name: tunnel_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List GRE Tunnel Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List GRE Tunnel Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Magic GRE tunnels
      summary: Update GRE Tunnel
      description: Updates a specific GRE tunnel. Use `?validate_only=true` as an
        optional query parameter to only run validation without persisting changes.
      operationId: magic-gre-tunnels-update-gre-tunnel
      parameters:
      - name: tunnel_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tunnel_update_request'
      responses:
        4xx:
          description: Update GRE Tunnel response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_modified_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update GRE Tunnel response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_modified_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/magic/ipsec_tunnels:
    get:
      tags:
      - Magic IPsec tunnels
      summary: List IPsec tunnels
      description: Lists IPsec tunnels associated with an account.
      operationId: magic-i-psec-tunnels-list-i-psec-tunnels
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List IPsec tunnels response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-tunnels_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List IPsec tunnels response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-tunnels_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Magic IPsec tunnels
      summary: Create IPsec tunnels
      description: Creates new IPsec tunnels associated with an account. Use `?validate_only=true`
        as an optional query parameter to only run validation without persisting changes.
      operationId: magic-i-psec-tunnels-create-i-psec-tunnels
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - customer_ipsec_endpoint
              - cloudflare_ipsec_endpoint
              - interface_address
      responses:
        4xx:
          description: Create IPsec tunnels response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-tunnels_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create IPsec tunnels response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-tunnels_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Magic IPsec tunnels
      summary: Update multiple IPsec tunnels
      description: Update multiple IPsec tunnels associated with an account. Use `?validate_only=true`
        as an optional query parameter to only run validation without persisting changes.
      operationId: magic-i-psec-tunnels-update-multiple-i-psec-tunnels
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        4xx:
          description: Update multiple IPsec tunnels response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-modified_tunnels_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update multiple IPsec tunnels response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-modified_tunnels_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}:
    delete:
      tags:
      - Magic IPsec tunnels
      summary: Delete IPsec Tunnel
      description: Disables and removes a specific static IPsec Tunnel associated
        with an account. Use `?validate_only=true` as an optional query parameter
        to only run validation without persisting changes.
      operationId: magic-i-psec-tunnels-delete-i-psec-tunnel
      parameters:
      - name: tunnel_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete IPsec Tunnel response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-tunnel_deleted_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete IPsec Tunnel response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-tunnel_deleted_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Magic IPsec tunnels
      summary: List IPsec tunnel details
      description: Lists details for a specific IPsec tunnel.
      operationId: magic-i-psec-tunnels-list-i-psec-tunnel-details
      parameters:
      - name: tunnel_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List IPsec tunnel details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-tunnel_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List IPsec tunnel details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-tunnel_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Magic IPsec tunnels
      summary: Update IPsec Tunnel
      description: Updates a specific IPsec tunnel associated with an account. Use
        `?validate_only=true` as an optional query parameter to only run validation
        without persisting changes.
      operationId: magic-i-psec-tunnels-update-i-psec-tunnel
      parameters:
      - name: tunnel_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas-tunnel_update_request'
      responses:
        4xx:
          description: Update IPsec Tunnel response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-tunnel_modified_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update IPsec Tunnel response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-tunnel_modified_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/magic/ipsec_tunnels/{tunnel_identifier}/psk_generate:
    post:
      tags:
      - Magic IPsec tunnels
      summary: Generate Pre Shared Key (PSK) for IPsec tunnels
      description: Generates a Pre Shared Key for a specific IPsec tunnel used in
        the IKE session. Use `?validate_only=true` as an optional query parameter
        to only run validation without persisting changes. After a PSK is generated,
        the PSK is immediately persisted to Cloudflare's edge and cannot be retrieved
        later. Note the PSK in a safe place.
      operationId: magic-i-psec-tunnels-generate-pre-shared-key-(-psk)-for-i-psec-tunnels
      parameters:
      - name: tunnel_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Generate Pre Shared Key (PSK) for IPsec tunnels response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/psk_generation_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Generate Pre Shared Key (PSK) for IPsec tunnels response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/psk_generation_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/magic/routes:
    get:
      tags:
      - Magic Static Routes
      summary: List Routes
      description: List all Magic static routes.
      operationId: magic-static-routes-list-routes
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Routes response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/routes_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Routes response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/routes_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Magic Static Routes
      summary: Create Routes
      description: Creates a new Magic static route. Use `?validate_only=true` as
        an optional query parameter to run validation only without persisting changes.
      operationId: magic-static-routes-create-routes
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - prefix
              - nexthop
              - priority
      responses:
        4xx:
          description: Create Routes response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/routes_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Routes response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/routes_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Magic Static Routes
      summary: Update Many Routes
      description: Update multiple Magic static routes. Use `?validate_only=true`
        as an optional query parameter to run validation only without persisting changes.
        Only fields for a route that need to be changed need be provided.
      operationId: magic-static-routes-update-many-routes
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/route_update_many_request'
      responses:
        4xx:
          description: Update Many Routes response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/multiple_route_modified_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Many Routes response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/multiple_route_modified_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/magic/routes/{route_identifier}:
    delete:
      tags:
      - Magic Static Routes
      summary: Delete Route
      description: Disable and remove a specific Magic static route.
      operationId: magic-static-routes-delete-route
      parameters:
      - name: route_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/route_deleted_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route_deleted_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Magic Static Routes
      summary: Route Details
      description: Get a specific Magic static route.
      operationId: magic-static-routes-route-details
      parameters:
      - name: route_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Route Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/route_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Route Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Magic Static Routes
      summary: Update Route
      description: Update a specific Magic static route. Use `?validate_only=true`
        as an optional query parameter to run validation only without persisting changes.
      operationId: magic-static-routes-update-route
      parameters:
      - name: route_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/route_update_request'
      responses:
        4xx:
          description: Update Route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/route_modified_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route_modified_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/members:
    get:
      tags:
      - Account Members
      summary: List Members
      description: List all members of an account.
      operationId: account-members-list-members
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      responses:
        4xx:
          description: List Members response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Members response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Account Members
      summary: Add Member
      description: Add a user to the list of members for this account.
      operationId: account-members-add-member
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create'
      responses:
        4xx:
          description: Add Member response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add Member response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/members/{identifier}:
    delete:
      tags:
      - Account Members
      summary: Remove Member
      description: Remove a member from an account.
      operationId: account-members-remove-member
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Remove Member response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Remove Member response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Account Members
      summary: Member Details
      description: Get information about a specific member of an account.
      operationId: account-members-member-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      responses:
        4xx:
          description: Member Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Member Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Account Members
      summary: Update Member
      description: Modify an account member.
      operationId: account-members-update-member
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas-member'
      responses:
        4xx:
          description: Update Member response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Member response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/mnm/config:
    delete:
      tags:
      - Magic Network Monitoring Configuration
      summary: Delete account configuration
      description: Delete an existing network monitoring configuration.
      operationId: magic-network-monitoring-configuration-delete-account-configuration
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/config_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete account configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_config'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete account configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_config'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Magic Network Monitoring Configuration
      summary: List account configuration
      description: Lists default sampling and router IPs for account.
      operationId: magic-network-monitoring-configuration-list-account-configuration
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/config_components-schemas-account_identifier'
      responses:
        4xx:
          description: List account configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_config'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List account configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_config'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Magic Network Monitoring Configuration
      summary: Update account configuration fields
      description: Update fields in an existing network monitoring configuration.
      operationId: magic-network-monitoring-configuration-update-account-configuration-fields
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/config_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Update account configuration fields response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_config'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update account configuration fields response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_config'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Magic Network Monitoring Configuration
      summary: Create account configuration
      description: Create a new network monitoring configuration.
      operationId: magic-network-monitoring-configuration-create-account-configuration
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/config_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Create account configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_config'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create account configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_config'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Magic Network Monitoring Configuration
      summary: Update an entire account configuration
      description: Update an existing network monitoring configuration, requires the
        entire configuration to be updated at once.
      operationId: magic-network-monitoring-configuration-update-an-entire-account-configuration
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/config_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Update an entire account configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_config'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an entire account configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_config'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/mnm/config/full:
    get:
      tags:
      - Magic Network Monitoring Configuration
      summary: List rules and account configuration
      description: Lists default sampling, router IPs, and rules for account.
      operationId: magic-network-monitoring-configuration-list-rules-and-account-configuration
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/config_components-schemas-account_identifier'
      responses:
        4xx:
          description: List rules and account configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_config'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List rules and account configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_config'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/mnm/rules:
    get:
      tags:
      - Magic Network Monitoring Rules
      summary: List rules
      description: Lists network monitoring rules for account.
      operationId: magic-network-monitoring-rules-list-rules
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-account_identifier'
      responses:
        4xx:
          description: List rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_rules'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_rules'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Magic Network Monitoring Rules
      summary: Create rules
      description: Create network monitoring rules for account.
      operationId: magic-network-monitoring-rules-create-rules
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Create rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_rules'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_rules'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Magic Network Monitoring Rules
      summary: Update rules
      description: Update network monitoring rules for account.
      operationId: magic-network-monitoring-rules-update-rules
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Update rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_rules'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_rules'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/mnm/rules/{rule_identifier}:
    delete:
      tags:
      - Magic Network Monitoring Rules
      summary: Delete rule
      description: Delete a network monitoring rule for account.
      operationId: magic-network-monitoring-rules-delete-rule
      parameters:
      - name: rule_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-rule_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_rule'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_rule'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Magic Network Monitoring Rules
      summary: Get rule
      description: List a single network monitoring rule for account.
      operationId: magic-network-monitoring-rules-get-rule
      parameters:
      - name: rule_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-rule_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-account_identifier'
      responses:
        4xx:
          description: Get rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_rule'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_rule'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Magic Network Monitoring Rules
      summary: Update rule
      description: Update a network monitoring rule for account.
      operationId: magic-network-monitoring-rules-update-rule
      parameters:
      - name: rule_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-rule_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Update rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_rule'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_rule'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/mnm/rules/{rule_identifier}/advertisement:
    patch:
      tags:
      - Magic Network Monitoring Rules
      summary: Update advertisement for rule
      description: Update advertisement for rule.
      operationId: magic-network-monitoring-rules-update-advertisement-for-rule
      parameters:
      - name: rule_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-rule_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Update advertisement for rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/mnm_rule_automatic_advertisement'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update advertisement for rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/mnm_rule_automatic_advertisement'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pages/projects:
    get:
      tags:
      - Pages Project
      summary: Get projects
      description: Fetch a list of all user projects.
      operationId: pages-project-get-projects
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      responses:
        4xx:
          description: Get projects response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/projects-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get projects response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/projects-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Pages Project
      summary: Create project
      description: Make a new project.
      operationId: pages-project-create-project
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/projects'
      responses:
        4xx:
          description: Create project response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/new-project-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create project response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/new-project-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pages/projects/{project_name}:
    delete:
      tags:
      - Pages Project
      summary: Delete project
      description: Destroy a project by name.
      operationId: pages-project-delete-project
      parameters:
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete project response failure
          content:
            application/json:
              schema:
                allOf:
                - example:
                    errors: []
                    messages: []
                    result: null
                    success: true
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete project response
          content:
            application/json:
              schema:
                example:
                  errors: []
                  messages: []
                  result: null
                  success: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Pages Project
      summary: Get project
      description: Fetch a project by name.
      operationId: pages-project-get-project
      parameters:
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      responses:
        4xx:
          description: Get project response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/project-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get project response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/project-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Pages Project
      summary: Update project
      description: Set new attributes for an existing project. Modify environment
        variables. To delete an environment variable, set the key to null.
      operationId: pages-project-update-project
      parameters:
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/project-patch'
      responses:
        4xx:
          description: Update project response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/new-project-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update project response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/new-project-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pages/projects/{project_name}/deployments:
    get:
      tags:
      - Pages Deployment
      summary: Get deployments
      description: Fetch a list of deployments from a project.
      operationId: pages-deployment-get-deployments
      parameters:
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      responses:
        4xx:
          description: Get deployments response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deployment-list-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get deployments response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deployment-list-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Pages Deployment
      summary: Create deployment
      description: Start a new deployment from production. The repo/account must have
        been authorized through the Pages UI dash before.
      operationId: pages-deployment-create-deployment
      parameters:
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Create deployment response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deployment-new-deployment'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create deployment response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deployment-new-deployment'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}:
    delete:
      tags:
      - Pages Deployment
      summary: Delete deployment
      description: Destroy a deployment.
      operationId: pages-deployment-delete-deployment
      parameters:
      - name: deployment_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete deployment response failure
          content:
            application/json:
              schema:
                allOf:
                - example:
                    errors: []
                    messages: []
                    result: null
                    success: true
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete deployment response
          content:
            application/json:
              schema:
                example:
                  errors: []
                  messages: []
                  result: null
                  success: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Pages Deployment
      summary: Get deployment info
      description: Fetch a deployment.
      operationId: pages-deployment-get-deployment-info
      parameters:
      - name: deployment_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      responses:
        4xx:
          description: Get deployment info response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deployment-response-details'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get deployment info response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deployment-response-details'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/history/logs:
    get:
      tags:
      - Pages Deployment
      summary: Get deployment logs
      description: Fetch deploy logs.
      operationId: pages-deployment-get-deployment-logs
      parameters:
      - name: deployment_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      responses:
        4xx:
          description: Get deployment logs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deployment-response-logs'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get deployment logs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deployment-response-logs'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/retry:
    post:
      tags:
      - Pages Deployment
      summary: Retry deployment
      description: Retry a previous deployment.
      operationId: pages-deployment-retry-deployment
      parameters:
      - name: deployment_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Retry deployment response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deployment-new-deployment'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Retry deployment response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deployment-new-deployment'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pages/projects/{project_name}/deployments/{deployment_identifier}/rollback:
    post:
      tags:
      - Pages Deployment
      summary: Rollback deployment
      description: Rollback the production deployment to a previous deploy. You can
        only rollback to succesful builds on production.
      operationId: pages-deployment-rollback-deployment
      parameters:
      - name: deployment_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Rollback deployment response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deployment-response-details'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Rollback deployment response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deployment-response-details'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pages/projects/{project_name}/domains:
    get:
      tags:
      - Pages Domains
      summary: Get domains
      description: Fetch a list of all domains.
      operationId: pages-domains-get-domains
      parameters:
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      responses:
        4xx:
          description: Get domains response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/domain-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get domains response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Pages Domains
      summary: Add domain
      description: Add a new domain for the Pages project.
      operationId: pages-domains-add-domain
      parameters:
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/domains-post'
      responses:
        4xx:
          description: Add domain response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/domain-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add domain response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pages/projects/{project_name}/domains/{domain_name}:
    delete:
      tags:
      - Pages Domains
      summary: Delete domain
      description: Delete a domain.
      operationId: pages-domains-delete-domain
      parameters:
      - name: domain_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/domain_name'
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete domain response failure
          content:
            application/json:
              schema:
                allOf:
                - example:
                    errors: []
                    messages: []
                    result: null
                    success: true
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete domain response
          content:
            application/json:
              schema:
                example:
                  errors: []
                  messages: []
                  result: null
                  success: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Pages Domains
      summary: Get domain
      description: Fetch a single domain.
      operationId: pages-domains-get-domain
      parameters:
      - name: domain_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/domain_name'
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      responses:
        4xx:
          description: Get domain response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/domain-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get domain response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Pages Domains
      summary: Patch domain
      description: Retry the validation status of a single domain.
      operationId: pages-domains-patch-domain
      parameters:
      - name: domain_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/domain_name'
      - name: project_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/project_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Patch domain response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/domain-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch domain response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pcaps:
    get:
      tags:
      - Magic PCAP collection
      summary: List packet capture requests
      description: Lists all packet capture requests for an account.
      operationId: magic-pcap-collection-list-packet-capture-requests
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List packet capture requests response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pcaps_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List packet capture requests response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pcaps_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Magic PCAP collection
      summary: Create PCAP request
      description: Create new PCAP request for account.
      operationId: magic-pcap-collection-create-pcap-request
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pcaps_request_pcap'
      responses:
        4xx:
          description: Create PCAP request response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pcaps_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create PCAP request response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pcaps_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pcaps/{identifier}:
    get:
      tags:
      - Magic PCAP collection
      summary: Get PCAP request
      description: Get information for a PCAP request by id.
      operationId: magic-pcap-collection-get-pcap-request
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get PCAP request response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pcaps_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get PCAP request response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pcaps_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pcaps/{identifier}/download:
    get:
      tags:
      - Magic PCAP collection
      summary: Download Simple PCAP
      description: Download PCAP information into a file. Response is a binary PCAP
        file.
      operationId: magic-pcap-collection-download-simple-pcap
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Download Simple PCAP response failure
          content:
            application/json: {}
        "200":
          description: Download Simple PCAP response
          content:
            application/json: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pcaps/ownership:
    get:
      tags:
      - Magic PCAP collection
      summary: List PCAPs Bucket Ownership
      description: List all buckets configured for use with PCAPs API.
      operationId: magic-pcap-collection-list-pca-ps-bucket-ownership
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List PCAPs Bucket Ownership response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pcaps_ownership_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List PCAPs Bucket Ownership response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pcaps_ownership_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Magic PCAP collection
      summary: Add buckets for full packet captures
      description: Adds an AWS or GCP bucket to use with full packet captures.
      operationId: magic-pcap-collection-add-buckets-for-full-packet-captures
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pcaps_ownership_request'
      responses:
        4xx:
          description: Add buckets for full packet captures response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pcaps_ownership_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add buckets for full packet captures response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pcaps_ownership_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pcaps/ownership/{identifier}:
    delete:
      tags:
      - Magic PCAP collection
      summary: Delete buckets for full packet captures
      description: Deletes buckets added to the packet captures API.
      operationId: magic-pcap-collection-delete-buckets-for-full-packet-captures
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete buckets for full packet captures response failure
          content:
            application/json: {}
        "200":
          description: Delete buckets for full packet captures response
          content:
            application/json: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/pcaps/ownership/validate:
    post:
      tags:
      - Magic PCAP collection
      summary: Validate buckets for full packet captures
      description: Validates buckets added to the packet captures API.
      operationId: magic-pcap-collection-validate-buckets-for-full-packet-captures
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/pcaps_ownership_validate_request'
      responses:
        4xx:
          description: Validate buckets for full packet captures response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pcaps_ownership_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Validate buckets for full packet captures response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pcaps_ownership_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/r2/buckets:
    get:
      tags:
      - R2 Bucket
      summary: List Buckets
      description: Lists all R2 buckets on your account
      operationId: r-2-bucket-list-buckets
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Buckets response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/r2-single-bucket-operation-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Buckets response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2-single-bucket-operation-response'
      security:
      - api_token: []
    post:
      tags:
      - R2 Bucket
      summary: Create Bucket
      description: Creates a new R2 bucket.
      operationId: r-2-bucket-create-bucket
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              example: '{''name'': ''example-bucket''}'
      responses:
        4xx:
          description: Create Bucket response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/r2-single-bucket-operation-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Bucket response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2-single-bucket-operation-response'
      security:
      - api_token: []
  /accounts/{account_identifier}/r2/buckets/{bucket_name}:
    delete:
      tags:
      - R2 Bucket
      summary: Delete Bucket
      description: Deletes an existing R2 bucket.
      operationId: r-2-bucket-delete-bucket
      parameters:
      - name: bucket_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bucket_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Bucket response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/r2-single-bucket-operation-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Bucket response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/r2-single-bucket-operation-response'
      security:
      - api_token: []
  /accounts/{account_identifier}/railguns:
    get:
      tags:
      - Account Railguns
      summary: List Railguns
      description: List, search, sort and filter your Railguns.
      operationId: account-railguns-list-railguns
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Railguns response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Railguns response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Account Railguns
      summary: Create Railgun
      operationId: account-railguns-create-railgun
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  $ref: '#/components/schemas/railgun_components-schemas-name'
      responses:
        4xx:
          description: Create Railgun response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Railgun response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/railguns/{identifier}:
    delete:
      tags:
      - Account Railguns
      summary: Delete a Railgun
      description: Disable and delete a Railgun. This will immediately disable the
        Railgun for any connected zones.
      operationId: account-railguns-delete-a-railgun
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a Railgun response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single_id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a Railgun response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single_id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Account Railguns
      summary: Railgun details
      operationId: account-railguns-railgun-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Railgun details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Railgun details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Account Railguns
      summary: Update Railgun
      description: Update a Railgun.
      operationId: account-railguns-update-railgun
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas-railgun'
      responses:
        4xx:
          description: Update Railgun response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Railgun response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/railguns/{railgun_identifier}/connections:
    get:
      tags:
      - Railgun Connections
      summary: List Connections
      description: List connections associated with the Railgun.
      operationId: railgun-connections-list-connections
      parameters:
      - name: railgun_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Connections response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/connection_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Connections response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connection_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Railgun Connections
      summary: Create connection
      description: Associates a zone to the Railgun.
      operationId: railgun-connections-create-connection
      parameters:
      - name: railgun_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/connection_single_request'
      responses:
        4xx:
          description: Create connection response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/connection_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create connection response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connection_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/railguns/{railgun_identifier}/connections/{identifier}:
    delete:
      tags:
      - Railgun Connections
      summary: Delete connection
      description: Disable and remove the connection to a zone.
      operationId: railgun-connections-delete-connection
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/connection_components-schemas-identifier'
      - name: railgun_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete connection response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/connection_single_id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete connection response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connection_single_id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Railgun Connections
      summary: Connection details
      description: Get a connection by ID.
      operationId: railgun-connections-connection-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/connection_components-schemas-identifier'
      - name: railgun_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Connection details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/connection_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Connection details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connection_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Railgun Connections
      summary: Update connection
      description: Enable or disable a connection.
      operationId: railgun-connections-update-connection
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/connection_components-schemas-identifier'
      - name: railgun_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas-connection'
      responses:
        4xx:
          description: Update connection response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/connection_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update connection response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/connection_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/registrar/domains:
    post:
      tags:
      - Registrar Domains
      summary: List domains
      description: List domains handled by Registrar.
      operationId: registrar-domains-list-domains
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
              properties:
                id:
                  $ref: '#/components/schemas/domain_names'
      responses:
        4xx:
          description: List domains response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/domain_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List domains response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/registrar/domains/{domain_name}:
    get:
      tags:
      - Registrar Domains
      summary: Get domain
      description: Show individual domain.
      operationId: registrar-domains-get-domain
      parameters:
      - name: domain_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/Cloudflare Client API_domain_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get domain response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/domain_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get domain response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Registrar Domains
      summary: Update domain
      description: Update individual domain.
      operationId: registrar-domains-update-domain
      parameters:
      - name: domain_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/Cloudflare Client API_domain_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              allOf:
              - $ref: '#/components/schemas/domain_update_properties'
      responses:
        4xx:
          description: Update domain response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/domain_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update domain response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/domain_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/roles:
    get:
      tags:
      - Account Roles
      summary: List Roles
      description: Get all available roles for an account.
      operationId: account-roles-list-roles
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      responses:
        4xx:
          description: List Roles response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Roles response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/roles/{identifier}:
    get:
      tags:
      - Account Roles
      summary: Role Details
      description: Get information about a specific role for an account.
      operationId: account-roles-role-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/account_identifier'
      responses:
        4xx:
          description: Role Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Role Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/rules/lists:
    get:
      tags:
      - Lists
      summary: Get lists
      description: Fetches all lists in the account.
      operationId: lists-get-lists
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get lists response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/lists-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get lists response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Lists
      summary: Create a list
      description: Creates a new list of the specified type.
      operationId: lists-create-a-list
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - kind
              properties:
                description:
                  $ref: '#/components/schemas/lists_components-schemas-description'
                kind:
                  $ref: '#/components/schemas/kind'
                name:
                  $ref: '#/components/schemas/lists_components-schemas-name'
      responses:
        4xx:
          description: Create a list response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/list-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a list response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/rules/lists/{list_id}:
    delete:
      tags:
      - Lists
      summary: Delete a list
      description: Deletes a specific list and all its items.
      operationId: lists-delete-a-list
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/list_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a list response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/list-delete-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a list response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-delete-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Lists
      summary: Get a list
      description: Fetches the details of a list.
      operationId: lists-get-a-list
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/list_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a list response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/list-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a list response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Lists
      summary: Update a list
      description: Updates the description of a list.
      operationId: lists-update-a-list
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/list_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                description:
                  $ref: '#/components/schemas/lists_components-schemas-description'
      responses:
        4xx:
          description: Update a list response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/list-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a list response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/rules/lists/{list_id}/items:
    delete:
      tags:
      - Lists
      summary: Delete list items
      description: |-
        Removes one or more items from a list.

        This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.
      operationId: lists-delete-list-items
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/list_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                items:
                  type: array
                  minItems: 1
                  items:
                    properties:
                      id:
                        $ref: '#/components/schemas/item_id'
      responses:
        4xx:
          description: Delete list items response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/lists-async-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete list items response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists-async-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Lists
      summary: Get list items
      description: Fetches all the items in the list.
      operationId: lists-get-list-items
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/list_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get list items response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/items-list-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get list items response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/items-list-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Lists
      summary: Create list items
      description: |-
        Appends new items to the list.

        This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.
      operationId: lists-create-list-items
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/list_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/items-update-request-collection'
      responses:
        4xx:
          description: Create list items response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/lists-async-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create list items response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists-async-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Lists
      summary: Update all list items
      description: |-
        Removes all existing items from the list and adds the provided items to the list.

        This operation is asynchronous. To get current the operation status, invoke the [Get bulk operation status](#lists-get-bulk-operation-status) endpoint with the returned `operation_id`.
      operationId: lists-update-all-list-items
      parameters:
      - name: list_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/list_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/items-update-request-collection'
      responses:
        4xx:
          description: Update all list items response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/lists-async-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update all list items response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists-async-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/rules/lists/{list_id}/items/{item_id}:
    get:
      tags:
      - Lists
      summary: Get a list item
      description: Fetches a list item in the list.
      operationId: lists-get-a-list-item
      parameters:
      - name: item_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/item_id'
      - name: list_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/list_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a list item response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/item-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a list item response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/item-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/rules/lists/bulk_operations/{operation_id}:
    get:
      tags:
      - Lists
      summary: Get bulk operation status
      description: |-
        Gets the current status of an asynchronous operation on a list.

        The `status` property can have one of the following values: `pending`, `running`, `completed`, or `failed`. If the status is `failed`, the `error` property will contain a message describing the error.
      operationId: lists-get-bulk-operation-status
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-operation_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get bulk operation status response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bulk-operation-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get bulk operation status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bulk-operation-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/secondary_dns/acls:
    get:
      tags:
      - Secondary DNS (ACL)
      summary: List ACLs
      description: List ACLs.
      operationId: secondary-dns-(-acl)-list-ac-ls
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      responses:
        4xx:
          description: List ACLs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/acl_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List ACLs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/acl_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Secondary DNS (ACL)
      summary: Create ACL
      description: Create ACL.
      operationId: secondary-dns-(-acl)-create-acl
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - ip_range
      responses:
        4xx:
          description: Create ACL response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/acl_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create ACL response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/acl_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/secondary_dns/acls/{identifier}:
    delete:
      tags:
      - Secondary DNS (ACL)
      summary: Delete ACL
      description: Delete ACL.
      operationId: secondary-dns-(-acl)-delete-acl
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/acl_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete ACL response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/acl_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete ACL response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/acl_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Secondary DNS (ACL)
      summary: ACL Details
      description: Get ACL.
      operationId: secondary-dns-(-acl)-acl-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/acl_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      responses:
        4xx:
          description: ACL Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/acl_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: ACL Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/acl_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Secondary DNS (ACL)
      summary: Update ACL
      description: Modify ACL.
      operationId: secondary-dns-(-acl)-update-acl
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/acl_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/acl'
      responses:
        4xx:
          description: Update ACL response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/acl_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update ACL response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/acl_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/secondary_dns/peers:
    get:
      tags:
      - Secondary DNS (Peer)
      summary: List Peers
      description: List Peers.
      operationId: secondary-dns-(-peer)-list-peers
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      responses:
        4xx:
          description: List Peers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/peer_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Peers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/peer_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Secondary DNS (Peer)
      summary: Create Peer
      description: Create Peer.
      operationId: secondary-dns-(-peer)-create-peer
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
      responses:
        4xx:
          description: Create Peer response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/peer_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Peer response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/peer_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/secondary_dns/peers/{identifier}:
    delete:
      tags:
      - Secondary DNS (Peer)
      summary: Delete Peer
      description: Delete Peer.
      operationId: secondary-dns-(-peer)-delete-peer
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/peer_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Peer response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/peer_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Peer response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/peer_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Secondary DNS (Peer)
      summary: Peer Details
      description: Get Peer.
      operationId: secondary-dns-(-peer)-peer-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/peer_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      responses:
        4xx:
          description: Peer Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/peer_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Peer Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/peer_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Secondary DNS (Peer)
      summary: Update Peer
      description: Modify Peer.
      operationId: secondary-dns-(-peer)-update-peer
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/peer_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/peer'
      responses:
        4xx:
          description: Update Peer response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/peer_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Peer response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/peer_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/secondary_dns/tsigs:
    get:
      tags:
      - Secondary DNS (TSIG)
      summary: List TSIGs
      description: List TSIGs.
      operationId: secondary-dns-(-tsig)-list-tsi-gs
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      responses:
        4xx:
          description: List TSIGs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tsig_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List TSIGs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tsig_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Secondary DNS (TSIG)
      summary: Create TSIG
      description: Create TSIG.
      operationId: secondary-dns-(-tsig)-create-tsig
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - algo
      responses:
        4xx:
          description: Create TSIG response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create TSIG response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/secondary_dns/tsigs/{identifier}:
    delete:
      tags:
      - Secondary DNS (TSIG)
      summary: Delete TSIG
      description: Delete TSIG.
      operationId: secondary-dns-(-tsig)-delete-tsig
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tsig_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete TSIG response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete TSIG response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Secondary DNS (TSIG)
      summary: TSIG Details
      description: Get TSIG.
      operationId: secondary-dns-(-tsig)-tsig-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tsig_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      responses:
        4xx:
          description: TSIG Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: TSIG Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Secondary DNS (TSIG)
      summary: Update TSIG
      description: Modify TSIG.
      operationId: secondary-dns-(-tsig)-update-tsig
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tsig_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/tsig'
      responses:
        4xx:
          description: Update TSIG response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update TSIG response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/storage/analytics:
    get:
      tags:
      - Workers KV Request Analytics
      summary: Query Request Analytics
      description: Retrieves Workers KV request metrics for the given account.
      operationId: workers-kv-request-analytics-query-request-analytics
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Query Request Analytics response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - type: object
                    properties:
                      result:
                        $ref: '#/components/schemas/components-schemas-result'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Query Request Analytics response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/components-schemas-result'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/storage/analytics/stored:
    get:
      tags:
      - Workers KV Stored Data Analytics
      summary: Query Stored Data Analytics
      description: Retrieves Workers KV stored data metrics for the given account.
      operationId: workers-kv-stored-data-analytics-query-stored-data-analytics
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Query Stored Data Analytics response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - type: object
                    properties:
                      result:
                        $ref: '#/components/schemas/stored_components-schemas-result'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Query Stored Data Analytics response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/stored_components-schemas-result'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/storage/kv/namespaces:
    get:
      tags:
      - Workers KV Namespace
      summary: List Namespaces
      description: Returns the namespaces owned by an account.
      operationId: workers-kv-namespace-list-namespaces
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Namespaces response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          $ref: '#/components/schemas/namespace'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Namespaces response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/namespace'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Workers KV Namespace
      summary: Create a Namespace
      description: Creates a namespace under the given title. A 400 is returned if
        the account already owns a namespace with this title. A namespace must be
        explicitly deleted to be replaced.
      operationId: workers-kv-namespace-create-a-namespace
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_rename_namespace_body'
      responses:
        4xx:
          description: Create a Namespace response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - type: object
                    properties:
                      result:
                        $ref: '#/components/schemas/namespace'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a Namespace response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/namespace'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}:
    delete:
      tags:
      - Workers KV Namespace
      summary: Remove a Namespace
      description: Deletes the namespace corresponding to the given ID.
      operationId: workers-kv-namespace-remove-a-namespace
      parameters:
      - name: namespace_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/namespace_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Remove a Namespace response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Remove a Namespace response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Workers KV Namespace
      summary: Rename a Namespace
      description: Modifies a namespace's title.
      operationId: workers-kv-namespace-rename-a-namespace
      parameters:
      - name: namespace_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/namespace_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_rename_namespace_body'
      responses:
        4xx:
          description: Rename a Namespace response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Rename a Namespace response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/bulk:
    delete:
      tags:
      - Workers KV Namespace
      summary: Delete multiple key-value pairs
      description: Remove multiple KV pairs from the Namespace. Body should be an
        array of up to 10,000 keys to be removed.
      operationId: workers-kv-namespace-delete-multiple-key-value-pairs
      parameters:
      - name: namespace_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/namespace_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulk_delete'
      responses:
        4xx:
          description: Delete multiple key-value pairs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete multiple key-value pairs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Workers KV Namespace
      summary: Write multiple key-value pairs
      description: Write multiple keys and values at once. Body should be an array
        of up to 10,000 key-value pairs to be stored, along with optional expiration
        information. Existing values and expirations will be overwritten. If neither
        expiration nor expiration_ttl is specified, the key-value pair will never
        expire. If both are set, `expiration_ttl` is used and `expiration` is ignored.
        The entire request size must be 100 megabytes or less.
      operationId: workers-kv-namespace-write-multiple-key-value-pairs
      parameters:
      - name: namespace_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/namespace_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/bulk_write'
      responses:
        4xx:
          description: Write multiple key-value pairs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Write multiple key-value pairs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/keys:
    get:
      tags:
      - Workers KV Namespace
      summary: List a Namespace's Keys
      description: Lists a namespace's keys.
      operationId: workers-kv-namespace-list-a-namespace'-s-keys
      parameters:
      - name: namespace_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/namespace_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List a Namespace's Keys response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-common'
                  - properties:
                      result:
                        type: array
                        items:
                          $ref: '#/components/schemas/key'
                      result_info:
                        properties:
                          count:
                            type: number
                            description: Total results returned based on your list
                              parameters.
                            example: 1
                          cursor:
                            $ref: '#/components/schemas/cursor'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List a Namespace's Keys response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-common'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/key'
                    result_info:
                      properties:
                        count:
                          type: number
                          description: Total results returned based on your list parameters.
                          example: 1
                        cursor:
                          $ref: '#/components/schemas/cursor'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/metadata/{key_name}:
    get:
      tags:
      - Workers KV Namespace
      summary: Read the metadata for a key
      description: Returns the metadata associated with the given key in the given
        namespace. Use URL-encoding to use special characters (e.g. :, !, %) in the
        key name.
      operationId: workers-kv-namespace-read-the-metadata-for-a-key
      parameters:
      - name: key_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/key_name'
      - name: namespace_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/namespace_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Read the metadata for a key response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/list_metadata'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Read the metadata for a key response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/list_metadata'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/storage/kv/namespaces/{namespace_identifier}/values/{key_name}:
    delete:
      tags:
      - Workers KV Namespace
      summary: Delete key-value pair
      description: Remove a KV pair from the Namespace. Use URL-encoding to use special
        characters (e.g. :, !, %) in the key name.
      operationId: workers-kv-namespace-delete-key-value-pair
      parameters:
      - name: key_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/key_name'
      - name: namespace_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/namespace_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete key-value pair response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete key-value pair response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Workers KV Namespace
      summary: Read key-value pair
      description: Returns the value associated with the given key in the given namespace.
        Use URL-encoding to use special characters (e.g. :, !, %) in the key name.
        If the KV-pair is set to expire at some point, the expiration time as measured
        in seconds since the UNIX epoch will be returned in the "Expiration" response
        header.
      operationId: workers-kv-namespace-read-key-value-pair
      parameters:
      - name: key_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/key_name'
      - name: namespace_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/namespace_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Read key-value pair response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/kv_components-schemas-value'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Read key-value pair response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/kv_components-schemas-value'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Workers KV Namespace
      summary: Write key-value pair with metadata
      description: Write a value identified by a key. Use URL-encoding to use special
        characters (e.g. :, !, %) in the key name. Body should be the value to be
        stored along with json metadata to be associated with the key/value pair.
        Existing values, expirations and metadata will be overwritten. If neither
        `expiration` nor `expiration_ttl` is specified, the key-value pair will never
        expire. If both are set, `expiration_ttl` is used and `expiration` is ignored.
      operationId: workers-kv-namespace-write-key-value-pair-with-metadata
      parameters:
      - name: key_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/key_name'
      - name: namespace_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/namespace_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - value
              - metadata
              properties:
                metadata:
                  $ref: '#/components/schemas/components-schemas-metadata'
                value:
                  $ref: '#/components/schemas/kv_components-schemas-value'
      responses:
        4xx:
          description: Write key-value pair with metadata response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Write key-value pair with metadata response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream:
    get:
      tags:
      - Stream Videos
      summary: List videos
      description: Lists up to 1000 videos from a single request. For a specific range,
        refer to the optional parameters.
      operationId: stream-videos-list-videos
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      responses:
        4xx:
          description: List videos response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/video_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List videos response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/video_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Stream Videos
      summary: Initiate video uploads using TUS
      description: Initiates a video upload using the TUS protocol. On success, the
        server responds with a status code 201 (created) and includes a `location`
        header to indicate where the content should be uploaded. Refer to https://tus.io
        for protocol details.
      operationId: stream-videos-initiate-video-uploads-using-tus
      parameters:
      - name: Tus-Resumable
        in: header
        required: true
        schema:
          $ref: '#/components/schemas/tus_resumable'
      - name: Upload-Creator
        in: header
        required: true
        schema:
          $ref: '#/components/schemas/creator'
      - name: Upload-Length
        in: header
        required: true
        schema:
          $ref: '#/components/schemas/upload_length'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Initiate video uploads using TUS response failure
          content:
            application/json: {}
        "200":
          description: Initiate video uploads using TUS response
          content:
            application/json: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/{identifier}:
    delete:
      tags:
      - Stream Videos
      summary: Delete video
      description: Deletes a video and its copies from Cloudflare Stream.
      operationId: stream-videos-delete-video
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/videos_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete video response failure
          content:
            application/json: {}
        "200":
          description: Delete video response
          content:
            application/json: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Stream Videos
      summary: Retrieve video details
      description: Fetches details for a single video.
      operationId: stream-videos-retrieve-video-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/videos_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      responses:
        4xx:
          description: Retrieve video details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/video_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Retrieve video details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/video_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Stream Videos
      summary: Associate videos to NFTs
      description: Asssociates videos with a token ID and contract address to transfer
        admin rights on a video. If a change in ownership of the ERC-721 token happens
        on the Ethereum blockchain, the new token owner can claim control of the video.
      operationId: stream-videos-associate-videos-to-nf-ts
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/videos_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/nft'
      responses:
        4xx:
          description: Associate videos to NFTs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/video_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Associate videos to NFTs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/video_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/{identifier}/embed:
    get:
      tags:
      - Stream Videos
      summary: Retreieve embed Code HTML
      description: Fetches an HTML code snippet to embed a video in a web page delivered
        through Cloudflare. On success, returns an HTML fragment for use on web pages
        to display a video. On failure, returns a JSON response body.
      operationId: stream-videos-retreieve-embed-code-html
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/videos_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      responses:
        4xx:
          description: Retreieve embed Code HTML response failure
          content:
            application/json:
              schema:
                allOf:
                - example: <stream id="ea95132c15732412d22c1476fa83f27a"></stream><script
                    data-cfasync="false" defer type="text/javascript" src="https://embed.cloudflarestream.com/embed/we4g.fla9.latest.js"></script>
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Retreieve embed Code HTML response
          content:
            application/json:
              schema:
                example: <stream id="ea95132c15732412d22c1476fa83f27a"></stream><script
                  data-cfasync="false" defer type="text/javascript" src="https://embed.cloudflarestream.com/embed/we4g.fla9.latest.js"></script>
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/{identifier}/token:
    post:
      tags:
      - Stream Videos
      summary: Create signed URL tokens for videso
      description: Creates a signed URL token for a video. If a body is not provided
        in the request, a token is created with default values.
      operationId: stream-videos-create-signed-url-tokens-for-videso
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/videos_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/signed_token_request'
      responses:
        4xx:
          description: Create signed URL tokens for videso response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/signed_token_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create signed URL tokens for videso response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/signed_token_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/{video_identifier}/captions:
    get:
      tags:
      - Stream Subtitles/Captions
      summary: List captions or subtitles
      description: Lists the available captions or subtitles for a specific video.
      operationId: stream-subtitles/-captions-list-captions-or-subtitles
      parameters:
      - name: video_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-video_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List captions or subtitles response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/language_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List captions or subtitles response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/language_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/{video_identifier}/captions/{language}:
    delete:
      tags:
      - Stream Subtitles/Captions
      summary: Delete captions or subtitles
      description: Removes the captions or subtitles from a video.
      operationId: stream-subtitles/-captions-delete-captions-or-subtitles
      parameters:
      - name: language
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/language'
      - name: video_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-video_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete captions or subtitles response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - properties:
                      result:
                        type: string
                        example: ""
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete captions or subtitles response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - properties:
                    result:
                      type: string
                      example: ""
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Stream Subtitles/Captions
      summary: Upload captions or subtitles
      description: Uploads the caption or subtitle file to the endpoint for a specific
        BCP47 language. One caption or subtitle file per language is allowed.
      operationId: stream-subtitles/-captions-upload-captions-or-subtitles
      parameters:
      - name: language
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/language'
      - name: video_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-video_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/caption_basic_upload'
      responses:
        4xx:
          description: Upload captions or subtitles response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/language_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Upload captions or subtitles response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/language_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/{video_identifier}/downloads:
    get:
      tags:
      - Stream MP4 Downloads
      summary: List downloads
      description: Lists the downloads created for a video.
      operationId: stream-m-p-4-downloads-list-downloads
      parameters:
      - name: video_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/video_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List downloads response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/downloads_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List downloads response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/downloads_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Stream MP4 Downloads
      summary: Create downloads
      description: Creates a download for a video when a video is ready to view.
      operationId: stream-m-p-4-downloads-create-downloads
      parameters:
      - name: video_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/video_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Create downloads response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/downloads_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create downloads response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/downloads_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/clip:
    post:
      tags:
      - Stream Video Clipping
      summary: Clip videos given a start and end time
      description: Clips a video based on the specified start and end times provided
        in seconds.
      operationId: stream-video-clipping-clip-videos-given-a-start-and-end-time
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/videoClipStandard'
      responses:
        4xx:
          description: Clip videos given a start and end time response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/clipResponseSingle'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Clip videos given a start and end time response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/clipResponseSingle'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/copy:
    post:
      tags:
      - Stream Videos
      summary: Upload videos from a URL
      description: Uploads a video to Stream from a provided URL.
      operationId: stream-videos-upload-videos-from-a-url
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/video_copy_request'
      responses:
        4xx:
          description: Upload videos from a URL response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/video_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Upload videos from a URL response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/video_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/direct_upload:
    post:
      tags:
      - Stream Videos
      summary: Upload videos via direct upload URLs
      description: Creates a direct upload that allows video uploads without an API
        key.
      operationId: stream-videos-upload-videos-via-direct-upload-ur-ls
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/direct_upload_request'
      responses:
        4xx:
          description: Upload videos via direct upload URLs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/direct_upload_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Upload videos via direct upload URLs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/direct_upload_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/keys:
    get:
      tags:
      - Stream Signing Keys
      summary: List signing keys
      description: Lists the video ID and creation date and time when a signing key
        was created.
      operationId: stream-signing-keys-list-signing-keys
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List signing keys response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/key_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List signing keys response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/key_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Stream Signing Keys
      summary: Create signing keys
      description: Creates an RSA private key in PEM and JWK formats. Key files are
        only displayed once after creation. Keys are created, used, and deleted independently
        of videos, and every key can sign any video.
      operationId: stream-signing-keys-create-signing-keys
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Create signing keys response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/key_generation_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create signing keys response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/key_generation_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/keys/{identifier}:
    delete:
      tags:
      - Stream Signing Keys
      summary: Delete signing keys
      description: Deletes signing keys and revokes all signed URLs generated with
        the key.
      operationId: stream-signing-keys-delete-signing-keys
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/keys_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete signing keys response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deleted_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete signing keys response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleted_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/live_inputs:
    get:
      tags:
      - Stream Live Inputs
      summary: List live inputs
      description: Lists the live inputs created for an account. To get the credentials
        needed to stream to a specific live input, request a single live input.
      operationId: stream-live-inputs-list-live-inputs
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List live inputs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/live_input_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List live inputs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/live_input_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Stream Live Inputs
      summary: Create a live input
      description: Creates a live input, and returns credentials that you or your
        users can use to stream live video to Cloudflare Stream.
      operationId: stream-live-inputs-create-a-live-input
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_input_request'
      responses:
        4xx:
          description: Create a live input response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/live_input_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a live input response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/live_input_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}:
    delete:
      tags:
      - Stream Live Inputs
      summary: Delete a live input
      description: Prevents a live input from being streamed to and makes the live
        input inaccessible to any future API calls.
      operationId: stream-live-inputs-delete-a-live-input
      parameters:
      - name: live_input_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/live_input_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a live input response failure
          content:
            application/json: {}
        "200":
          description: Delete a live input response
          content:
            application/json: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Stream Live Inputs
      summary: Retrieve a live input
      description: Retrieves details of an existing live input.
      operationId: stream-live-inputs-retrieve-a-live-input
      parameters:
      - name: live_input_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/live_input_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Retrieve a live input response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/live_input_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Retrieve a live input response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/live_input_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Stream Live Inputs
      summary: Update a live input
      description: Updates a specified live input.
      operationId: stream-live-inputs-update-a-live-input
      parameters:
      - name: live_input_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/live_input_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_input_request'
      responses:
        4xx:
          description: Update a live input response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/live_input_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a live input response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/live_input_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}/outputs:
    get:
      tags:
      - Stream Live Inputs
      summary: List all outputs associated with a specified live input
      description: Retrieves all outputs associated with a specified live input.
      operationId: stream-live-inputs-list-all-outputs-associated-with-a-specified-live-input
      parameters:
      - name: live_input_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/live_input_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List all outputs associated with a specified live input response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/output_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List all outputs associated with a specified live input response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/output_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Stream Live Inputs
      summary: Create a new output, connected to a live input
      description: Creates a new output that can be used to simulcast or restream
        live video to other RTMP or SRT destinations. Outputs are always linked to
        a specific live input — one live input can have many outputs.
      operationId: stream-live-inputs-create-a-new-output,-connected-to-a-live-input
      parameters:
      - name: live_input_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/live_input_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_output_request'
      responses:
        4xx:
          description: Create a new output, connected to a live input response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/output_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a new output, connected to a live input response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/output_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/live_inputs/{live_input_identifier}/outputs/{output_identifier}:
    delete:
      tags:
      - Stream Live Inputs
      summary: Delete an output
      description: Deletes an output and removes it from the associated live input.
      operationId: stream-live-inputs-delete-an-output
      parameters:
      - name: output_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/output_identifier'
      - name: live_input_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/live_input_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an output response failure
          content:
            application/json: {}
        "200":
          description: Delete an output response
          content:
            application/json: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Stream Live Inputs
      summary: Update an output
      description: Updates the state of an output.
      operationId: stream-live-inputs-update-an-output
      parameters:
      - name: output_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/output_identifier'
      - name: live_input_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/live_input_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_output_request'
      responses:
        4xx:
          description: Update an output response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/output_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an output response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/output_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/watermarks:
    get:
      tags:
      - Stream Watermark Profile
      summary: List watermark profiles
      description: Lists all watermark profiles for an account.
      operationId: stream-watermark-profile-list-watermark-profiles
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      responses:
        4xx:
          description: List watermark profiles response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/watermark_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List watermark profiles response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/watermark_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Stream Watermark Profile
      summary: Create watermark profiles via basic upload
      description: Creates watermark profiles using a single `HTTP POST multipart/form-data`
        request.
      operationId: stream-watermark-profile-create-watermark-profiles-via-basic-upload
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/watermark_basic_upload'
      responses:
        4xx:
          description: Create watermark profiles via basic upload response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/watermark_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create watermark profiles via basic upload response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/watermark_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/watermarks/{identifier}:
    delete:
      tags:
      - Stream Watermark Profile
      summary: Delete watermark profiles
      description: Deletes a watermark profile.
      operationId: stream-watermark-profile-delete-watermark-profiles
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/watermarks_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete watermark profiles response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - properties:
                      result:
                        type: string
                        example: ""
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete watermark profiles response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - properties:
                    result:
                      type: string
                      example: ""
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Stream Watermark Profile
      summary: Watermark profile details
      description: Retrieves details for a single watermark profile.
      operationId: stream-watermark-profile-watermark-profile-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/watermarks_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-account_identifier'
      responses:
        4xx:
          description: Watermark profile details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/watermark_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Watermark profile details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/watermark_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/stream/webhook:
    delete:
      tags:
      - Stream Webhook
      summary: Delete webhooks
      description: Deletes a webhook.
      operationId: stream-webhook-delete-webhooks
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/webhook_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete webhooks response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deleted_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete webhooks response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deleted_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Stream Webhook
      summary: View webhooks
      description: Retrieves a list of webhooks.
      operationId: stream-webhook-view-webhooks
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/webhook_components-schemas-account_identifier'
      responses:
        4xx:
          description: View webhooks response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: View webhooks response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Stream Webhook
      summary: Create webhooks
      description: Creates a webhook notification.
      operationId: stream-webhook-create-webhooks
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/webhook_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/webhook_request'
      responses:
        4xx:
          description: Create webhooks response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhook_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create webhooks response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhook_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/subscriptions:
    get:
      tags:
      - Account Subscriptions
      summary: List Subscriptions
      description: Lists all of an account's subscriptions.
      operationId: account-subscriptions-list-subscriptions
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Subscriptions response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_subscription_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Subscriptions response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account_subscription_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Account Subscriptions
      summary: Create Subscription
      description: Creates an account subscription.
      operationId: account-subscriptions-create-subscription
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscription-v2'
      responses:
        4xx:
          description: Create Subscription response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_subscription_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Subscription response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account_subscription_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/subscriptions/{subscription_identifier}:
    delete:
      tags:
      - Account Subscriptions
      summary: Delete Subscription
      description: Deletes an account's subscription.
      operationId: account-subscriptions-delete-subscription
      parameters:
      - name: subscription_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/subscription-v2_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Subscription response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - properties:
                      result:
                        type: object
                        properties:
                          subscription_id:
                            $ref: '#/components/schemas/subscription-v2_components-schemas-identifier'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Subscription response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - properties:
                    result:
                      type: object
                      properties:
                        subscription_id:
                          $ref: '#/components/schemas/subscription-v2_components-schemas-identifier'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Account Subscriptions
      summary: Update Subscription
      description: Updates an account subscription.
      operationId: account-subscriptions-update-subscription
      parameters:
      - name: subscription_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/subscription-v2_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscription-v2'
      responses:
        4xx:
          description: Update Subscription response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account_subscription_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Subscription response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account_subscription_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/teamnet/routes:
    get:
      tags:
      - Tunnel route
      summary: List tunnel routes
      description: Lists and filters private network routes in an account.
      operationId: tunnel-route-list-tunnel-routes
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      responses:
        4xx:
          description: List tunnel routes response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/route_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List tunnel routes response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/teamnet/routes/ip/{ip}:
    get:
      tags:
      - Tunnel route
      summary: Get tunnel route by IP
      description: Fetches routes that contain the given IP address.
      operationId: tunnel-route-get-tunnel-route-by-ip
      parameters:
      - name: ip
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/teamnet_components-schemas-ip'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      responses:
        4xx:
          description: Get tunnel route by IP response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/route_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get tunnel route by IP response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/teamnet/routes/network/{ip_network_encoded}:
    delete:
      tags:
      - Tunnel route
      summary: Delete a tunnel route
      description: Deletes a private network route from an account. The CIDR in `ip_network_encoded`
        must be written in URL-encoded format.
      operationId: tunnel-route-delete-a-tunnel-route
      parameters:
      - name: ip_network_encoded
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/ip_network_encoded'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                virtual_network_id:
                  $ref: '#/components/schemas/virtual_network_id'
      responses:
        4xx:
          description: Delete a tunnel route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/route_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a tunnel route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Tunnel route
      summary: Update a tunnel route
      description: Updates an existing private network route in an account. The CIDR
        in `ip_network_encoded` must be written in URL-encoded format.
      operationId: tunnel-route-update-a-tunnel-route
      parameters:
      - name: ip_network_encoded
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/ip_network_encoded'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                comment:
                  $ref: '#/components/schemas/comment'
                network:
                  description: The new IPv4 or IPv6 range of this route, in CIDR notation.
                tunnel_id:
                  description: UUID of the tunnel this route should belong to.
                virtual_network_id:
                  $ref: '#/components/schemas/virtual_network_id'
      responses:
        4xx:
          description: Update a tunnel route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/route_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a tunnel route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Tunnel route
      summary: Create a tunnel route
      description: Routes a private network through a Cloudflare Tunnel. The CIDR
        in `ip_network_encoded` must be written in URL-encoded format.
      operationId: tunnel-route-create-a-tunnel-route
      parameters:
      - name: ip_network_encoded
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/ip_network_encoded'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - tunnel_id
              properties:
                comment:
                  $ref: '#/components/schemas/comment'
                tunnel_id:
                  $ref: '#/components/schemas/tunnel_id'
                virtual_network_id:
                  $ref: '#/components/schemas/virtual_network_id'
      responses:
        4xx:
          description: Create a tunnel route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/route_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a tunnel route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/teamnet/virtual_networks:
    get:
      tags:
      - Tunnel Virtual Network
      summary: List virtual networks
      description: Lists and filters virtual networks in an account.
      operationId: tunnel-virtual-network-list-virtual-networks
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      responses:
        4xx:
          description: List virtual networks response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vnet_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List virtual networks response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vnet_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Tunnel Virtual Network
      summary: Create a virtual network
      description: Adds a new virtual network to an account.
      operationId: tunnel-virtual-network-create-a-virtual-network
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                comment:
                  $ref: '#/components/schemas/schemas-comment'
                is_default:
                  $ref: '#/components/schemas/is_default_network'
                name:
                  $ref: '#/components/schemas/vnet_name'
      responses:
        4xx:
          description: Create a virtual network response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vnet_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a virtual network response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vnet_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/teamnet/virtual_networks/{vnet_id}:
    delete:
      tags:
      - Tunnel Virtual Network
      summary: Delete a virtual network
      description: Deletes an existing virtual network.
      operationId: tunnel-virtual-network-delete-a-virtual-network
      parameters:
      - name: vnet_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/vnet_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a virtual network response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vnet_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a virtual network response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vnet_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Tunnel Virtual Network
      summary: Update a virtual network
      description: Updates an existing virtual network.
      operationId: tunnel-virtual-network-update-a-virtual-network
      parameters:
      - name: vnet_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/vnet_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                comment:
                  $ref: '#/components/schemas/schemas-comment'
                is_default_network:
                  $ref: '#/components/schemas/is_default_network'
                name:
                  $ref: '#/components/schemas/vnet_name'
      responses:
        4xx:
          description: Update a virtual network response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/vnet_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a virtual network response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/vnet_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/tunnels:
    get:
      tags:
      - Argo Tunnel
      summary: List Argo Tunnels
      description: Lists and filters Argo Tunnels in an account.
      operationId: argo-tunnel-list-argo-tunnels
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      responses:
        4xx:
          description: List Argo Tunnels response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Argo Tunnels response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_response_collection'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Argo Tunnel
      summary: Create an Argo Tunnel
      description: Creates a new Argo Tunnel in an account.
      operationId: argo-tunnel-create-an-argo-tunnel
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - tunnel_secret
              properties:
                name:
                  $ref: '#/components/schemas/tunnel_name'
                tunnel_secret:
                  description: Sets the password required to run the tunnel. Must
                    be at least 32 bytes and encoded as a base64 string.
      responses:
        4xx:
          description: Create an Argo Tunnel response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create an Argo Tunnel response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_response_single'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/tunnels/{tunnel_id}:
    delete:
      tags:
      - Argo Tunnel
      summary: Delete an Argo Tunnel
      description: Deletes an Argo Tunnel from an account.
      operationId: argo-tunnel-delete-an-argo-tunnel
      parameters:
      - name: tunnel_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        4xx:
          description: Delete an Argo Tunnel response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an Argo Tunnel response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_response_single'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Argo Tunnel
      summary: Get an Argo Tunnel
      description: Fetches a single Argo Tunnel.
      operationId: argo-tunnel-get-an-argo-tunnel
      parameters:
      - name: tunnel_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      responses:
        4xx:
          description: Get an Argo Tunnel response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tunnel_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an Argo Tunnel response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tunnel_response_single'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/tunnels/{tunnel_id}/connections:
    delete:
      tags:
      - Argo Tunnel
      summary: Clean up Argo Tunnel connections
      description: Removes connections that are in a disconnected or pending reconnect
        state. We recommend running this command after shutting down a tunnel.
      operationId: argo-tunnel-clean-up-argo-tunnel-connections
      parameters:
      - name: tunnel_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/tunnel_id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cf_account_id'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        4xx:
          description: Clean up Argo Tunnel connections response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/argo-tunnel_components-schemas-empty_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Clean up Argo Tunnel connections response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/argo-tunnel_components-schemas-empty_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/virtual_dns:
    get:
      tags:
      - DNS Firewall (Legacy)
      summary: List DNS Firewall Clusters
      description: List configured DNS Firewall clusters for an account.
      operationId: dns-firewall-(-legacy)-list-dns-firewall-clusters
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List DNS Firewall Clusters response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/virtual_dns_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List DNS Firewall Clusters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/virtual_dns_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - DNS Firewall (Legacy)
      summary: Create DNS Firewall Cluster
      description: Create a configured DNS Firewall Cluster.
      operationId: dns-firewall-(-legacy)-create-dns-firewall-cluster
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - origin_ips
              - virtual_dns_ips
              properties:
                deprecate_any_requests:
                  $ref: '#/components/schemas/deprecate_any_requests'
                ecs_fallback:
                  $ref: '#/components/schemas/ecs_fallback'
                maximum_cache_ttl:
                  $ref: '#/components/schemas/maximum_cache_ttl'
                minimum_cache_ttl:
                  $ref: '#/components/schemas/minimum_cache_ttl'
                name:
                  $ref: '#/components/schemas/virtual-dns_components-schemas-name'
                negative_cache_ttl:
                  $ref: '#/components/schemas/schemas-negative_cache_ttl'
                origin_ips:
                  $ref: '#/components/schemas/origin_ips'
                ratelimit:
                  $ref: '#/components/schemas/schemas-ratelimit'
      responses:
        4xx:
          description: Create DNS Firewall Cluster response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/virtual_dns_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create DNS Firewall Cluster response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/virtual_dns_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/virtual_dns/{identifier}:
    delete:
      tags:
      - DNS Firewall (Legacy)
      summary: Delete DNS Firewall Cluster
      description: Delete a configured DNS Firewall Cluster.
      operationId: dns-firewall-(-legacy)-delete-dns-firewall-cluster
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete DNS Firewall Cluster response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/common_components-schemas-identifier'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete DNS Firewall Cluster response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/common_components-schemas-identifier'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - DNS Firewall (Legacy)
      summary: DNS Firewall Cluster Details
      description: Show a single configured DNS Firewall cluster for an account.
      operationId: dns-firewall-(-legacy)-dns-firewall-cluster-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: DNS Firewall Cluster Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/virtual_dns_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: DNS Firewall Cluster Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/virtual_dns_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - DNS Firewall (Legacy)
      summary: Update DNS Firewall Cluster
      description: Modify a DNS Firewall Cluster configuration.
      operationId: dns-firewall-(-legacy)-update-dns-firewall-cluster
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas-virtual-dns'
      responses:
        4xx:
          description: Update DNS Firewall Cluster response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/virtual_dns_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update DNS Firewall Cluster response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/virtual_dns_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/virtual_dns/{identifier}/dns_analytics/report:
    get:
      tags:
      - DNS Firewall Analytics (Legacy)
      summary: Table
      description: Retrieves a list of summarised aggregate metrics over a given time
        period.
      operationId: dns-firewall-analytics-(-legacy)-table
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Table response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - type: object
                    properties:
                      result:
                        $ref: '#/components/schemas/result'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Table response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/result'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/virtual_dns/{identifier}/dns_analytics/report/bytime:
    get:
      tags:
      - DNS Firewall Analytics (Legacy)
      summary: By Time
      description: Retrieves a list of aggregate metrics grouped by time interval.
      operationId: dns-firewall-analytics-(-legacy)-by-time
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: By Time response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - type: object
                    properties:
                      result:
                        $ref: '#/components/schemas/result'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: By Time response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/result'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/account-settings:
    get:
      tags:
      - Worker Account Settings
      summary: Fetch Worker Account Settings
      description: Fetches Worker Account Settings for an account.
      operationId: worker-account-settings-fetch-worker-account-settings
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Fetch Worker Account Settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account-settings-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Fetch Worker Account Settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account-settings-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Worker Account Settings
      summary: Create Worker Account Settings
      description: Creates Worker Account Settings for an account.
      operationId: worker-account-settings-create-worker-account-settings
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              example: '{''default_usage_model'': ''unbound''}'
      responses:
        4xx:
          description: Create Worker Account Settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/account-settings-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Worker Account Settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/account-settings-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/deployments/by-script/{script_identifier}:
    get:
      tags:
      - Worker Deployments
      summary: List Deployments
      operationId: worker-deployments-list-deployments
      parameters:
      - name: script_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Deployments response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deployments-list-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Deployments response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deployments-list-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/deployments/by-script/{script_identifier}/detail/{deployment_identifier}:
    get:
      tags:
      - Worker Deployments
      summary: Get Deployment Detail
      operationId: worker-deployments-get-deployment-detail
      parameters:
      - name: deployment_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/deployment_identifier'
      - name: script_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Deployment Detail response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/deployments-single-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Deployment Detail response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/deployments-single-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/domains:
    get:
      tags:
      - Worker Domain
      summary: List Domains
      description: Lists all Worker Domains.
      operationId: worker-domain-list-domains
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/domains_components-schemas-account_identifier'
      responses:
        4xx:
          description: List Domains response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Cloudflare Client API_domain-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Domains response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cloudflare Client API_domain-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Worker Domain
      summary: Attach to Domain
      description: Attaches a worker to a zone and hostname.
      operationId: worker-domain-attach-to-domain
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/domains_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - zone_id
              - hostname
              - service
              - environment
              properties:
                environment:
                  $ref: '#/components/schemas/environment'
                hostname:
                  $ref: '#/components/schemas/components-schemas-hostname'
                service:
                  $ref: '#/components/schemas/service'
                zone_id:
                  $ref: '#/components/schemas/zone_identifier'
      responses:
        4xx:
          description: Attach to Domain response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Cloudflare Client API_domain-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Attach to Domain response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cloudflare Client API_domain-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/domains/{domain_identifier}:
    delete:
      tags:
      - Worker Domain
      summary: Detach from Domain
      description: Detaches a worker from a zone and hostname.
      operationId: worker-domain-detach-from-domain
      parameters:
      - name: domain_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/domain_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/domains_components-schemas-account_identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Detach from Domain response failure
          content:
            application/json: {}
        "200":
          description: Detach from Domain response
          content:
            application/json: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Worker Domain
      summary: Get a Domain
      description: Gets a Worker Domain.
      operationId: worker-domain-get-a-domain
      parameters:
      - name: domain_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/domain_identifier'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/domains_components-schemas-account_identifier'
      responses:
        4xx:
          description: Get a Domain response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/Cloudflare Client API_domain-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a Domain response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Cloudflare Client API_domain-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/durable_objects/namespaces:
    get:
      tags:
      - Durable Objects Namespace
      summary: List Namespaces
      description: Returns the namespaces owned by an account.
      operationId: durable-objects-namespace-list-namespaces
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Namespaces response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          $ref: '#/components/schemas/schemas-namespace'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Namespaces response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/schemas-namespace'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/durable_objects/namespaces/{id}/objects:
    get:
      tags:
      - Durable Objects Namespace
      summary: List Objects
      description: Returns the Durable Objects in a given namespace.
      operationId: durable-objects-namespace-list-objects
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/namespaces_components-schemas-id'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Objects response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          $ref: '#/components/schemas/object'
                      result_info:
                        properties:
                          count:
                            type: number
                            description: Total results returned based on your list
                              parameters.
                            example: 1
                          cursor:
                            $ref: '#/components/schemas/schemas-cursor'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Objects response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/object'
                    result_info:
                      properties:
                        count:
                          type: number
                          description: Total results returned based on your list parameters.
                          example: 1
                        cursor:
                          $ref: '#/components/schemas/schemas-cursor'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/queues:
    get:
      tags:
      - Queue
      summary: List Queues
      description: Returns the queues owned by an account.
      operationId: queue-list-queues
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Queues response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - properties:
                      errors:
                        nullable: true
                  - properties:
                      messages:
                        nullable: true
                  - properties:
                      result_info:
                        type: object
                        properties:
                          count:
                            example: 1
                          page:
                            example: 1
                          per_page:
                            example: 100
                          total_count:
                            example: 1
                          total_pages:
                            example: 1
                  - type: object
                    required:
                    - queue_id
                    - queue_name
                    - created_on
                    - modified_on
                    - producers_total_count
                    - producers
                    - consumers_total_count
                    - consumers
                    properties:
                      result:
                        type: array
                        items:
                          $ref: '#/components/schemas/queue'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Queues response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - properties:
                    errors:
                      nullable: true
                - properties:
                    messages:
                      nullable: true
                - properties:
                    result_info:
                      type: object
                      properties:
                        count:
                          example: 1
                        page:
                          example: 1
                        per_page:
                          example: 100
                        total_count:
                          example: 1
                        total_pages:
                          example: 1
                - type: object
                  required:
                  - queue_id
                  - queue_name
                  - created_on
                  - modified_on
                  - producers_total_count
                  - producers
                  - consumers_total_count
                  - consumers
                  properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/queue'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Queue
      summary: Create Queue
      description: Creates a new queue.
      operationId: queue-create-queue
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              example:
                queue_name: example-queue
      responses:
        4xx:
          description: Create Queue response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - type: object
                    required:
                    - queue_id
                    - queue_name
                    - created_on
                    - modified_on
                    properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/queue_created'
                        type: object
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Queue response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - type: object
                  required:
                  - queue_id
                  - queue_name
                  - created_on
                  - modified_on
                  properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/queue_created'
                      type: object
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/queues/{name}:
    delete:
      tags:
      - Queue
      summary: Delete Queue
      description: Deletes a queue.
      operationId: queue-delete-queue
      parameters:
      - name: name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/queues_components-schemas-name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Queue response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - nullable: true
                    properties:
                      result:
                        nullable: true
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Queue response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - nullable: true
                  properties:
                    result:
                      nullable: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Queue
      summary: Queue Details
      description: Get information about a specific queue.
      operationId: queue-queue-details
      parameters:
      - name: name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/queues_components-schemas-name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Queue Details response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - type: object
                    required:
                    - queue_id
                    - queue_name
                    - created_on
                    - modified_on
                    properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/queue'
                        type: object
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Queue Details response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - type: object
                  required:
                  - queue_id
                  - queue_name
                  - created_on
                  - modified_on
                  properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/queue'
                      type: object
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Queue
      summary: Update Queue
      description: Updates a queue.
      operationId: queue-update-queue
      parameters:
      - name: name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/queues_components-schemas-name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              example:
                queue_name: renamed-example-queue
      responses:
        4xx:
          description: Update Queue response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - type: object
                    required:
                    - queue_id
                    - queue_name
                    - created_on
                    - modified_on
                    properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/queue_updated'
                        type: object
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Queue response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - type: object
                  required:
                  - queue_id
                  - queue_name
                  - created_on
                  - modified_on
                  properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/queue_updated'
                      type: object
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/queues/{name}/consumers:
    get:
      tags:
      - Queue
      summary: List Queue Consumers
      description: Returns the consumers for a queue.
      operationId: queue-list-queue-consumers
      parameters:
      - name: name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/queues_components-schemas-name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Queue Consumers response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - properties:
                      errors:
                        nullable: true
                  - properties:
                      messages:
                        nullable: true
                  - properties:
                      result_info:
                        type: object
                        properties:
                          count:
                            example: 1
                          page:
                            example: 1
                          per_page:
                            example: 100
                          total_count:
                            example: 1
                          total_pages:
                            example: 1
                  - type: object
                    required:
                    - queue_name
                    - created_on
                    - settings
                    properties:
                      result:
                        type: array
                        items:
                          $ref: '#/components/schemas/consumer'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Queue Consumers response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - properties:
                    errors:
                      nullable: true
                - properties:
                    messages:
                      nullable: true
                - properties:
                    result_info:
                      type: object
                      properties:
                        count:
                          example: 1
                        page:
                          example: 1
                        per_page:
                          example: 100
                        total_count:
                          example: 1
                        total_pages:
                          example: 1
                - type: object
                  required:
                  - queue_name
                  - created_on
                  - settings
                  properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/consumer'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Queue
      summary: Create Queue Consumer
      description: Creates a new consumer for a queue.
      operationId: queue-create-queue-consumer
      parameters:
      - name: name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/queues_components-schemas-name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              example:
                dead_letter_queue: example-dlq
                environment: production
                script_name: example-consumer
                settings:
                  batch_size: 10
                  max_retries: 3
                  max_wait_time_ms: 5000
      responses:
        4xx:
          description: Create Queue Consumer response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - type: object
                    required:
                    - queue_name
                    - script_name
                    - settings
                    - dead_letter_queue
                    - created_on
                    properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/consumer_created'
                        type: object
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Queue Consumer response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - type: object
                  required:
                  - queue_name
                  - script_name
                  - settings
                  - dead_letter_queue
                  - created_on
                  properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/consumer_created'
                      type: object
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/queues/{name}/consumers/{consumer_name}:
    delete:
      tags:
      - Queue
      summary: Delete Queue Consumer
      description: Deletes the consumer for a queue.
      operationId: queue-delete-queue-consumer
      parameters:
      - name: consumer_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/consumer_name'
      - name: name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/queues_components-schemas-name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Queue Consumer response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - nullable: true
                    properties:
                      result:
                        nullable: true
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Queue Consumer response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - nullable: true
                  properties:
                    result:
                      nullable: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Queue
      summary: Update Queue Consumer
      description: Updates the consumer for a queue, or creates one if it does not
        exist.
      operationId: queue-update-queue-consumer
      parameters:
      - name: consumer_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/consumer_name'
      - name: name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/queues_components-schemas-name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              example:
                dead_letter_queue: updated-example-dlq
                environment: production
                script_name: example-consumer
                settings:
                  batch_size: 100
      responses:
        4xx:
          description: Update Queue Consumer response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - type: object
                    required:
                    - queue_name
                    - script_name
                    - settings
                    - dead_letter_queue
                    - created_on
                    properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/consumer_updated'
                        type: object
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Queue Consumer response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - type: object
                  required:
                  - queue_name
                  - script_name
                  - settings
                  - dead_letter_queue
                  - created_on
                  properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/consumer_updated'
                      type: object
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/scripts:
    get:
      tags:
      - Worker Script
      summary: List Workers
      description: Fetch a list of uploaded workers.
      operationId: worker-script-list-workers
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Workers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/script-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Workers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/script-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/scripts/{script_name}:
    delete:
      tags:
      - Worker Script
      summary: Delete Worker
      description: |-
        Delete your worker. This call has no response body on a successful delete.

        **Query paramaters**:

        1.  `force`: boolean;   If set to true, delete will not be stopped by associated service binding, durable object, or other binding. Any of these associated bindings/durable objects will be deleted along with the script.
      operationId: worker-script-delete-worker
      parameters:
      - name: script_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Worker response failure
          content:
            application/json: {}
        "200":
          description: Delete Worker response
          content:
            application/json: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Worker Script
      summary: Download Worker
      description: Fetch raw script content for your worker. Note this is the original
        script content, not JSON encoded.
      operationId: worker-script-download-worker
      parameters:
      - name: script_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Download Worker response failure
          content:
            undefined:
              schema:
                example: addEventListener('fetch', event => { event.respondWith(fetch(event.request))
                  })
        "200":
          description: Download Worker response
          content:
            undefined:
              schema:
                example: addEventListener('fetch', event => { event.respondWith(fetch(event.request))
                  })
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Worker Script
      summary: Upload Worker Module
      description: Upload a worker module.
      operationId: worker-script-upload-worker-module
      parameters:
      - name: script_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              properties:
                '"second-file.js"':
                  type: string
                  description: Worker script.
                  example: '@second-file.js;type=application/javascript+module'
                '"worker.js"':
                  type: string
                  description: Worker script.
                  example: '@worker.js;type=application/javascript+module'
                metadata:
                  type: string
                  description: Metadata for script such as bindings. Main module needs
                    to be specified with `main_module`.
                  example: '{"main_module": "worker.js", "some_binding": "stuff"}'
      responses:
        4xx:
          description: Upload Worker Module response failure
          content:
            application/json:
              schema:
                allOf:
                - example:
                    errors: []
                    messages: []
                    result:
                      created_on: "2022-05-05T05:15:11.602148Z"
                      etag: 777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1
                      handlers:
                      - fetch
                      id: this-is_my_script-01
                      modified_on: "2022-05-20T19:02:56.446492Z"
                      usage_model: bundled
                    success: true
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Upload Worker Module response
          content:
            application/json:
              schema:
                example:
                  errors: []
                  messages: []
                  result:
                    created_on: "2022-05-05T05:15:11.602148Z"
                    etag: 777f24a43bef5f69174aa69ceaf1dea67968d510a31d1vw3e49d34a0187c06d1
                    handlers:
                    - fetch
                    id: this-is_my_script-01
                    modified_on: "2022-05-20T19:02:56.446492Z"
                    usage_model: bundled
                  success: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/scripts/{script_name}/schedules:
    get:
      tags:
      - Worker Cron Trigger
      summary: Get Cron Triggers
      description: Fetches Cron Triggers for a Worker.
      operationId: worker-cron-trigger-get-cron-triggers
      parameters:
      - name: script_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Cron Triggers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cron-trigger-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Cron Triggers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cron-trigger-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Worker Cron Trigger
      summary: Update Cron Triggers
      description: Updates Cron Triggers for a Worker.
      operationId: worker-cron-trigger-update-cron-triggers
      parameters:
      - name: script_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              example: '[{''cron'': ''*/30 * * * *''}]'
      responses:
        4xx:
          description: Update Cron Triggers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/cron-trigger-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Cron Triggers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/cron-trigger-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/scripts/{script_name}/tails:
    get:
      tags:
      - Worker Tail Logs
      summary: List Tails
      description: Get list of tails currently deployed on a worker.
      operationId: worker-tail-logs-list-tails
      parameters:
      - name: script_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Tails response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tail-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Tails response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tail-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Worker Tail Logs
      summary: Start Tail
      description: Starts a tail that receives logs and exception from a Worker.
      operationId: worker-tail-logs-start-tail
      parameters:
      - name: script_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Start Tail response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/tail-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Start Tail response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/tail-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/scripts/{script_name}/tails/{id}:
    delete:
      tags:
      - Worker Tail Logs
      summary: Delete Tail
      description: Deletes a tail from a Worker.
      operationId: worker-tail-logs-delete-tail
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-id'
      - name: script_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Tail response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-common'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Tail response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-common'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/scripts/{script_name}/usage-model:
    get:
      tags:
      - Worker Script
      summary: Fetch Usage Model
      description: Fetches the Usage Model for a given Worker.
      operationId: worker-script-fetch-usage-model
      parameters:
      - name: script_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Fetch Usage Model response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/usage-model-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Fetch Usage Model response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usage-model-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Worker Script
      summary: Update Usage Model
      description: Updates the Usage Model for a given Worker. Requires a Workers
        Paid subscription.
      operationId: worker-script-update-usage-model
      parameters:
      - name: script_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script_name'
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              example: '{''usage_model'': ''unbound''}'
      responses:
        4xx:
          description: Update Usage Model response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/usage-model-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Usage Model response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/usage-model-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier}/workers/subdomain:
    get:
      tags:
      - Worker Subdomain
      summary: Get Subdomain
      description: Returns a Workers subdomain for an account.
      operationId: worker-subdomain-get-subdomain
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Subdomain response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/subdomain-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Subdomain response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subdomain-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Worker Subdomain
      summary: Create Subdomain
      description: Creates a Workers subdomain for an account.
      operationId: worker-subdomain-create-subdomain
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              example: '{''subdomain'': ''example-subdomain''}'
      responses:
        4xx:
          description: Create Subdomain response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/subdomain-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Subdomain response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/subdomain-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{account_identifier1}/addressing/address_maps/{address_map_identifier}/accounts/{account_identifier}:
    delete:
      tags:
      - IP Address Management Address Maps
      summary: Remove an account membership from an Address Map
      description: Remove an account as a member of a particular address map.
      operationId: ip-address-management-address-maps-remove-an-account-membership-from-an-address-map
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: address_map_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Remove an account membership from an Address Map response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Remove an account membership from an Address Map response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - IP Address Management Address Maps
      summary: Add an account membership to an Address Map
      description: Add an account as a member of a particular address map.
      operationId: ip-address-management-address-maps-add-an-account-membership-to-an-address-map
      parameters:
      - name: account_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: address_map_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: account_identifier1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Add an account membership to an Address Map response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add an account membership to an Address Map response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}:
    get:
      tags:
      - Accounts
      summary: Account Details
      description: Get information about a specific account that you are a member
        of.
      operationId: accounts-account-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      responses:
        4xx:
          description: Account Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Account Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Accounts
      summary: Update Account
      description: Update an existing account.
      operationId: accounts-update-account
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/components-schemas-account'
      responses:
        4xx:
          description: Update Account response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Account response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/apps:
    get:
      tags:
      - Access applications
      summary: List Access applications
      description: Lists all Access applications in an account.
      operationId: access-applications-list-access-applications
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      responses:
        4xx:
          description: List Access applications response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apps_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Access applications response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apps_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Access applications
      summary: Add a Bookmark application
      description: Adds a custom link to the App Launcher. Bookmark applications are
        not protected by Access.
      operationId: access-applications-add-a-bookmark-application
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              - domain
      responses:
        4xx:
          description: Add a Bookmark application response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/apps_components-schemas-single_response'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/basic_app_response_props'
                        - $ref: '#/components/schemas/bookmark_props'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add a Bookmark application response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apps_components-schemas-single_response'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/basic_app_response_props'
                      - $ref: '#/components/schemas/bookmark_props'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/apps/{app_id}:
    delete:
      tags:
      - Access applications
      summary: Delete an Access application
      description: Deletes an application from Access.
      operationId: access-applications-delete-an-access-application
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an Access application response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apps_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an Access application response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apps_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Access applications
      summary: Get an Access application
      description: Fetches information about an Access application.
      operationId: access-applications-get-an-access-application
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      responses:
        4xx:
          description: Get an Access application response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apps_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an Access application response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apps_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Access applications
      summary: Update a Bookmark application
      description: Updates a Bookmark application.
      operationId: access-applications-update-a-bookmark-application
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              - domain
      responses:
        4xx:
          description: Update a Bookmark application response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/apps_components-schemas-single_response'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/basic_app_response_props'
                        - $ref: '#/components/schemas/bookmark_props'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a Bookmark application response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apps_components-schemas-single_response'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/basic_app_response_props'
                      - $ref: '#/components/schemas/bookmark_props'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/apps/{app_id}/revoke_tokens:
    post:
      tags:
      - Access applications
      summary: Revoke service tokens
      description: Revokes all service tokens used by an application.
      operationId: access-applications-revoke-service-tokens
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Revoke service tokens response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-empty_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Revoke service tokens response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-empty_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/apps/{app_id}/user_policy_checks:
    get:
      tags:
      - Access applications
      summary: Test Access policies
      description: Tests if a specific user has permission to access an application.
      operationId: access-applications-test-access-policies
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      responses:
        4xx:
          description: Test Access policies response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policy_check_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Test Access policies response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policy_check_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/apps/{uuid}/ca:
    delete:
      tags:
      - Access short-lived certificate CAs
      summary: Delete a short-lived certificate CA
      description: Deletes a short-lived certificate CA.
      operationId: access-short-lived-certificate-c-as-delete-a-short-lived-certificate-ca
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a short-lived certificate CA response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ca_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a short-lived certificate CA response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ca_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Access short-lived certificate CAs
      summary: Get a short-lived certificate CA
      description: Fetches a short-lived certificate CA and its public key.
      operationId: access-short-lived-certificate-c-as-get-a-short-lived-certificate-ca
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a short-lived certificate CA response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ca_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a short-lived certificate CA response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ca_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Access short-lived certificate CAs
      summary: Create a short-lived certificate CA
      description: Generates a new short-lived certificate CA and public key.
      operationId: access-short-lived-certificate-c-as-create-a-short-lived-certificate-ca
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Create a short-lived certificate CA response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ca_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a short-lived certificate CA response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ca_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/apps/{uuid}/policies:
    get:
      tags:
      - Access policies
      summary: List Access policies
      description: Lists Access policies configured for an application.
      operationId: access-policies-list-access-policies
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/policies_components-schemas-identifier'
      responses:
        4xx:
          description: List Access policies response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Access policies response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Access policies
      summary: Create an Access policy
      description: Create a new Access policy for an application.
      operationId: access-policies-create-an-access-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/policies_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - decision
              - include
              properties:
                approval_groups:
                  $ref: '#/components/schemas/approval_groups'
                approval_required:
                  $ref: '#/components/schemas/approval_required'
                decision:
                  $ref: '#/components/schemas/decision'
                exclude:
                  $ref: '#/components/schemas/schemas-exclude'
                include:
                  $ref: '#/components/schemas/include'
                name:
                  $ref: '#/components/schemas/policies_components-schemas-name'
                precedence:
                  $ref: '#/components/schemas/precedence'
                purpose_justification_prompt:
                  $ref: '#/components/schemas/purpose_justification_prompt'
                purpose_justification_required:
                  $ref: '#/components/schemas/purpose_justification_required'
                require:
                  $ref: '#/components/schemas/schemas-require'
      responses:
        4xx:
          description: Create an Access policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create an Access policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/apps/{uuid1}/policies/{uuid}:
    delete:
      tags:
      - Access policies
      summary: Delete an Access policy
      description: Delete an Access policy.
      operationId: access-policies-delete-an-access-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-uuid'
      - name: uuid1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/policies_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an Access policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an Access policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Access policies
      summary: Get an Access policy
      description: Fetches a single Access policy.
      operationId: access-policies-get-an-access-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-uuid'
      - name: uuid1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/policies_components-schemas-identifier'
      responses:
        4xx:
          description: Get an Access policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an Access policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Access policies
      summary: Update an Access policy
      description: Update a configured Access policy.
      operationId: access-policies-update-an-access-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-uuid'
      - name: uuid1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/policies_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - decision
              - include
              properties:
                approval_groups:
                  $ref: '#/components/schemas/approval_groups'
                approval_required:
                  $ref: '#/components/schemas/approval_required'
                decision:
                  $ref: '#/components/schemas/decision'
                exclude:
                  $ref: '#/components/schemas/schemas-exclude'
                include:
                  $ref: '#/components/schemas/include'
                name:
                  $ref: '#/components/schemas/policies_components-schemas-name'
                precedence:
                  $ref: '#/components/schemas/precedence'
                purpose_justification_prompt:
                  $ref: '#/components/schemas/purpose_justification_prompt'
                purpose_justification_required:
                  $ref: '#/components/schemas/purpose_justification_required'
                require:
                  $ref: '#/components/schemas/schemas-require'
      responses:
        4xx:
          description: Update an Access policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an Access policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/apps/ca:
    get:
      tags:
      - Access short-lived certificate CAs
      summary: List short-lived certificate CAs
      description: Lists short-lived certificate CAs and their public keys.
      operationId: access-short-lived-certificate-c-as-list-short-lived-certificate-c-as
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List short-lived certificate CAs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ca_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List short-lived certificate CAs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ca_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/bookmarks:
    get:
      tags:
      - Access Bookmark applications (Deprecated)
      summary: List Bookmark applications
      description: Lists Bookmark applications.
      operationId: access-bookmark-applications-(-deprecated)-list-bookmark-applications
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bookmarks_components-schemas-identifier'
      responses:
        4xx:
          description: List Bookmark applications response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bookmarks_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Bookmark applications response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bookmarks_components-schemas-response_collection'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/bookmarks/{uuid}:
    delete:
      tags:
      - Access Bookmark applications (Deprecated)
      summary: Delete a Bookmark application
      description: Deletes a Bookmark application.
      operationId: access-bookmark-applications-(-deprecated)-delete-a-bookmark-application
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bookmarks_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a Bookmark application response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bookmarks_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a Bookmark application response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bookmarks_components-schemas-id_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Access Bookmark applications (Deprecated)
      summary: Get a Bookmark application
      description: Fetches a single Bookmark application.
      operationId: access-bookmark-applications-(-deprecated)-get-a-bookmark-application
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bookmarks_components-schemas-identifier'
      responses:
        4xx:
          description: Get a Bookmark application response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bookmarks_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a Bookmark application response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bookmarks_components-schemas-single_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Access Bookmark applications (Deprecated)
      summary: Create a Bookmark application
      description: Create a new Bookmark application.
      operationId: access-bookmark-applications-(-deprecated)-create-a-bookmark-application
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bookmarks_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Create a Bookmark application response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bookmarks_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a Bookmark application response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bookmarks_components-schemas-single_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Access Bookmark applications (Deprecated)
      summary: Update a Bookmark application
      description: Updates a configured Bookmark application.
      operationId: access-bookmark-applications-(-deprecated)-update-a-bookmark-application
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/bookmarks_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Update a Bookmark application response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/bookmarks_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a Bookmark application response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/bookmarks_components-schemas-single_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/certificates:
    get:
      tags:
      - Access mTLS authentication
      summary: List mTLS certificates
      description: Lists all mTLS certificates.
      operationId: access-m-tls-authentication-list-m-tls-certificates
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List mTLS certificates response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificates_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List mTLS certificates response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificates_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Access mTLS authentication
      summary: Add an mTLS certificate
      description: Adds a new mTLS root certificate to Access.
      operationId: access-m-tls-authentication-add-an-m-tls-certificate
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - certificate
              properties:
                associated_hostnames:
                  $ref: '#/components/schemas/associated_hostnames'
                certificate:
                  type: string
                  description: The certificate content.
                  example: |-
                    -----BEGIN CERTIFICATE-----
                    MIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10
                    DrUtmu/B
                    -----END CERTIFICATE-----
                name:
                  $ref: '#/components/schemas/certificates_components-schemas-name'
      responses:
        4xx:
          description: Add an mTLS certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificates_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add an mTLS certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificates_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/certificates/{uuid}:
    delete:
      tags:
      - Access mTLS authentication
      summary: Delete an mTLS certificate
      description: Deletes an mTLS certificate.
      operationId: access-m-tls-authentication-delete-an-m-tls-certificate
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an mTLS certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificates_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an mTLS certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificates_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Access mTLS authentication
      summary: Get an mTLS certificate
      description: Fetches a single mTLS certificate.
      operationId: access-m-tls-authentication-get-an-m-tls-certificate
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get an mTLS certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificates_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an mTLS certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificates_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Access mTLS authentication
      summary: Update an mTLS certificate
      description: Updates a configured mTLS certificate.
      operationId: access-m-tls-authentication-update-an-m-tls-certificate
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - associated_hostnames
              properties:
                associated_hostnames:
                  $ref: '#/components/schemas/associated_hostnames'
                name:
                  $ref: '#/components/schemas/certificates_components-schemas-name'
      responses:
        4xx:
          description: Update an mTLS certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificates_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an mTLS certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificates_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/groups:
    get:
      tags:
      - Access groups
      summary: List Access groups
      description: Lists all Access groups.
      operationId: access-groups-list-access-groups
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Access groups response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/groups_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Access groups response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/groups_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Access groups
      summary: Create an Access group
      description: Creates a new Access group.
      operationId: access-groups-create-an-access-group
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - include
              properties:
                exclude:
                  $ref: '#/components/schemas/exclude'
                include:
                  $ref: '#/components/schemas/include'
                name:
                  $ref: '#/components/schemas/groups_components-schemas-name'
                require:
                  $ref: '#/components/schemas/require'
      responses:
        4xx:
          description: Create an Access group response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/groups_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create an Access group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/groups_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/groups/{uuid}:
    delete:
      tags:
      - Access groups
      summary: Delete an Access group
      description: Deletes an Access group.
      operationId: access-groups-delete-an-access-group
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an Access group response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/groups_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an Access group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/groups_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Access groups
      summary: Get an Access group
      description: Fetches a single Access group.
      operationId: access-groups-get-an-access-group
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get an Access group response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/groups_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an Access group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/groups_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Access groups
      summary: Update an Access group
      description: Updates a configured Access group.
      operationId: access-groups-update-an-access-group
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - include
              properties:
                exclude:
                  $ref: '#/components/schemas/exclude'
                include:
                  $ref: '#/components/schemas/include'
                name:
                  $ref: '#/components/schemas/groups_components-schemas-name'
                require:
                  $ref: '#/components/schemas/require'
      responses:
        4xx:
          description: Update an Access group response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/groups_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an Access group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/groups_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/identity_providers:
    get:
      tags:
      - Access identity providers
      summary: List Access identity providers
      description: Lists all configured identity providers.
      operationId: access-identity-providers-list-access-identity-providers
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identity-providers_components-schemas-identifier'
      responses:
        4xx:
          description: List Access identity providers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/identity-providers_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Access identity providers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity-providers_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Access identity providers
      summary: Add an Access identity provider
      description: Adds a new identity provider to Access.
      operationId: access-identity-providers-add-an-access-identity-provider
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identity-providers_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              - config
              properties:
                config:
                  $ref: '#/components/schemas/schemas-config'
                name:
                  $ref: '#/components/schemas/identity-providers_components-schemas-name'
                type:
                  $ref: '#/components/schemas/identity-providers_components-schemas-type'
      responses:
        4xx:
          description: Add an Access identity provider response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add an Access identity provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/identity_providers/{uuid}:
    delete:
      tags:
      - Access identity providers
      summary: Delete an Access identity provider
      description: Deletes an identity provider from Access.
      operationId: access-identity-providers-delete-an-access-identity-provider
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identity-providers_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an Access identity provider response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an Access identity provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Access identity providers
      summary: Get an Access identity provider
      description: Fetches a configured identity provider.
      operationId: access-identity-providers-get-an-access-identity-provider
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identity-providers_components-schemas-identifier'
      responses:
        4xx:
          description: Get an Access identity provider response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an Access identity provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Access identity providers
      summary: Update an Access identity provider
      description: Updates a configured identity provider.
      operationId: access-identity-providers-update-an-access-identity-provider
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identity-providers_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              - config
              properties:
                config:
                  $ref: '#/components/schemas/schemas-config'
                name:
                  $ref: '#/components/schemas/identity-providers_components-schemas-name'
                type:
                  $ref: '#/components/schemas/identity-providers_components-schemas-type'
      responses:
        4xx:
          description: Update an Access identity provider response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an Access identity provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/keys:
    get:
      tags:
      - Access key configuration
      summary: Get the Access key configuration
      description: Gets the Access key rotation settings for an account.
      operationId: access-key-configuration-get-the-access-key-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/keys_components-schemas-identifier-2'
      responses:
        4xx:
          description: Get the Access key configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/keys_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get the Access key configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keys_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Access key configuration
      summary: Update the Access key configuration
      description: Updates the Access key rotation settings for an account.
      operationId: access-key-configuration-update-the-access-key-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/keys_components-schemas-identifier-2'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - key_rotation_interval_days
              properties:
                key_rotation_interval_days:
                  $ref: '#/components/schemas/key_rotation_interval_days'
      responses:
        4xx:
          description: Update the Access key configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/keys_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update the Access key configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keys_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/keys/rotate:
    post:
      tags:
      - Access key configuration
      summary: Rotate Access keys
      description: Perfoms a key rotation for an account.
      operationId: access-key-configuration-rotate-access-keys
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/keys_components-schemas-identifier-2'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Rotate Access keys response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/keys_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Rotate Access keys response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keys_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/logs/access_requests:
    get:
      tags:
      - Access authentication logs
      summary: Get Access authentication logs
      description: Gets a list of Access authentication audit logs for an account.
      operationId: access-authentication-logs-get-access-authentication-logs
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/access-requests_components-schemas-identifier'
      responses:
        4xx:
          description: Get Access authentication logs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/access-requests_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Access authentication logs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/access-requests_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/organizations:
    get:
      tags:
      - Zero Trust organization
      summary: Get your Zero Trust organization
      description: Returns the configuration for your Zero Trust organization.
      operationId: zero-trust-organization-get-your-zero-trust-organization
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/organizations_components-schemas-identifier'
      responses:
        4xx:
          description: Get your Zero Trust organization response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/organizations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get your Zero Trust organization response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zero Trust organization
      summary: Create your Zero Trust organization
      description: Sets up a Zero Trust organization for your account.
      operationId: zero-trust-organization-create-your-zero-trust-organization
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/organizations_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - auth_domain
              properties:
                auth_domain:
                  $ref: '#/components/schemas/auth_domain'
                is_ui_read_only:
                  $ref: '#/components/schemas/is_ui_read_only'
                login_design:
                  $ref: '#/components/schemas/login_design'
                name:
                  $ref: '#/components/schemas/organizations_components-schemas-name'
      responses:
        4xx:
          description: Create your Zero Trust organization response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/organizations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create your Zero Trust organization response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zero Trust organization
      summary: Update your Zero Trust organization
      description: Updates the configuration for your Zero Trust organization.
      operationId: zero-trust-organization-update-your-zero-trust-organization
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/organizations_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                auth_domain:
                  $ref: '#/components/schemas/auth_domain'
                is_ui_read_only:
                  $ref: '#/components/schemas/is_ui_read_only'
                login_design:
                  $ref: '#/components/schemas/login_design'
                name:
                  $ref: '#/components/schemas/organizations_components-schemas-name'
      responses:
        4xx:
          description: Update your Zero Trust organization response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/organizations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update your Zero Trust organization response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/organizations/revoke_user:
    post:
      tags:
      - Zero Trust organization
      summary: Revoke all Access tokens for a user
      description: Revokes a user's access across all applications.
      operationId: zero-trust-organization-revoke-all-access-tokens-for-a-user
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/organizations_components-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:
        4xx:
          description: Revoke all Access tokens for a user response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-empty_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Revoke all Access tokens for a user response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-empty_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/seats:
    patch:
      tags:
      - Zero Trust seats
      summary: Update a user seat
      description: Removes a user from a Zero Trust seat when both `access_seat` and
        `gateway_seat` are set to false.
      operationId: zero-trust-seats-update-a-user-seat
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/seats_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/seats_definition'
      responses:
        4xx:
          description: Update a user seat response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/seats_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a user seat response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/seats_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/service_tokens:
    get:
      tags:
      - Access service tokens
      summary: List service tokens
      description: Lists all service tokens.
      operationId: access-service-tokens-list-service-tokens
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List service tokens response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service-tokens_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List service tokens response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service-tokens_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Access service tokens
      summary: 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 rotate the Client Secret or create a new service token.
      operationId: access-service-tokens-create-a-service-token
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              properties:
                name:
                  $ref: '#/components/schemas/service-tokens_components-schemas-name'
      responses:
        4xx:
          description: Create a service token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/create_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a service token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/create_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/service_tokens/{uuid}:
    delete:
      tags:
      - Access service tokens
      summary: Delete a service token
      description: Deletes a service token.
      operationId: access-service-tokens-delete-a-service-token
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a service token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service-tokens_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a service token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service-tokens_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Access service tokens
      summary: Update a service token
      description: Updates a configured service token.
      operationId: access-service-tokens-update-a-service-token
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/service-tokens_components-schemas-name'
      responses:
        4xx:
          description: Update a service token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service-tokens_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a service token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service-tokens_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/service_tokens/{uuid}/refresh:
    post:
      tags:
      - Access service tokens
      summary: Refresh a service token
      description: Refreshes the expiration of a service token.
      operationId: access-service-tokens-refresh-a-service-token
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Refresh a service token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service-tokens_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Refresh a service token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service-tokens_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/service_tokens/{uuid}/rotate:
    post:
      tags:
      - Access service tokens
      summary: Rotate a service token
      description: Generates a new Client Secret for a service token and revokes the
        old one.
      operationId: access-service-tokens-rotate-a-service-token
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Rotate a service token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/create_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Rotate a service token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/create_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/users:
    get:
      tags:
      - Zero Trust users
      summary: Get users
      description: Gets a list of users for an account.
      operationId: zero-trust-users-get-users
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/users_components-schemas-identifier'
      responses:
        4xx:
          description: Get users response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/users_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get users response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/users_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/access/users/{id}/failed_logins:
    get:
      tags:
      - Zero Trust users
      summary: Get failed logins
      description: Get all failed login attempts for a single user.
      operationId: zero-trust-users-get-failed-logins
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/users_components-schemas-id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/users_components-schemas-identifier'
      responses:
        4xx:
          description: Get failed logins response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/failed_login_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get failed logins response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/failed_login_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/alerting/v3/available_alerts:
    get:
      tags:
      - Notification Alert Types
      summary: Get Alert Types
      description: Gets a list of all alert types for which an account is eligible.
      operationId: notification-alert-types-get-alert-types
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Alert Types response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/alert-types_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Alert Types response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/alert-types_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/alerting/v3/destinations/eligible:
    get:
      tags:
      - Notification Mechanism Eligibility
      summary: Get delivery mechanism eligibility
      description: Get a list of all delivery mechanism types for which an account
        is eligible.
      operationId: notification-mechanism-eligibility-get-delivery-mechanism-eligibility
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get delivery mechanism eligibility response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/eligibility_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get delivery mechanism eligibility response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eligibility_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/alerting/v3/destinations/pagerduty:
    get:
      tags:
      - Notification destinations with PagerDuty
      summary: List PagerDuty services
      description: Get a list of all configured PagerDuty services.
      operationId: notification-destinations-with-pager-duty-list-pager-duty-services
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List PagerDuty services response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pagerduty_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List PagerDuty services response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pagerduty_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/alerting/v3/destinations/webhooks:
    get:
      tags:
      - Notification webhooks
      summary: List webhooks
      description: Gets a list of all configured webhook destinations.
      operationId: notification-webhooks-list-webhooks
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List webhooks response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhooks_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List webhooks response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhooks_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Notification webhooks
      summary: Create a webhook
      description: Creates a new webhook destination.
      operationId: notification-webhooks-create-a-webhook
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - url
              properties:
                name:
                  $ref: '#/components/schemas/webhooks_components-schemas-name'
                secret:
                  $ref: '#/components/schemas/schemas-secret'
                url:
                  $ref: '#/components/schemas/webhooks_components-schemas-url'
      responses:
        4xx:
          description: Create a webhook response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhooks_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a webhook response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhooks_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/alerting/v3/destinations/webhooks/{uuid}:
    delete:
      tags:
      - Notification webhooks
      summary: Delete a webhook
      description: Delete a configured webhook destination.
      operationId: notification-webhooks-delete-a-webhook
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a webhook response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a webhook response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Notification webhooks
      summary: Get a webhook
      description: Get details for a single webhooks destination.
      operationId: notification-webhooks-get-a-webhook
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a webhook response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhooks_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a webhook response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhooks_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Notification webhooks
      summary: Update a webhook
      description: Update a webhook destination.
      operationId: notification-webhooks-update-a-webhook
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - url
              properties:
                name:
                  $ref: '#/components/schemas/webhooks_components-schemas-name'
                secret:
                  $ref: '#/components/schemas/schemas-secret'
                url:
                  $ref: '#/components/schemas/webhooks_components-schemas-url'
      responses:
        4xx:
          description: Update a webhook response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/webhooks_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a webhook response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/webhooks_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/alerting/v3/history:
    get:
      tags:
      - Notification History
      summary: List History
      description: Gets a list of history records for notifications sent to an account.
        The records are displayed for last `x` number of days based on the zone plan
        (free = 30, pro = 30, biz = 30, ent = 90).
      operationId: notification-history-list-history
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List History response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/history_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List History response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/history_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/alerting/v3/policies:
    get:
      tags:
      - Notification policies
      summary: List Notification policies
      description: Get a list of all Notification policies.
      operationId: notification-policies-list-notification-policies
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Notification policies response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-response_collection-2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Notification policies response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-response_collection-2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Notification policies
      summary: Create a Notification policy
      description: Creates a new Notification policy.
      operationId: notification-policies-create-a-notification-policy
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - alert_type
              - enabled
              - mechanisms
              properties:
                alert_type:
                  $ref: '#/components/schemas/alert_type'
                description:
                  $ref: '#/components/schemas/policies_components-schemas-description'
                enabled:
                  $ref: '#/components/schemas/policies_components-schemas-enabled'
                filters:
                  $ref: '#/components/schemas/components-schemas-filters'
                mechanisms:
                  $ref: '#/components/schemas/mechanisms'
                name:
                  $ref: '#/components/schemas/policies_components-schemas-name-2'
      responses:
        4xx:
          description: Create a Notification policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-id_response-2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a Notification policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-id_response-2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/alerting/v3/policies/{uuid}:
    delete:
      tags:
      - Notification policies
      summary: Delete a Notification policy
      description: Delete a Notification policy.
      operationId: notification-policies-delete-a-notification-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a Notification policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a Notification policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Notification policies
      summary: Get a Notification policy
      description: Get details for a single policy.
      operationId: notification-policies-get-a-notification-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a Notification policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-single_response-2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a Notification policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-single_response-2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Notification policies
      summary: Update a Notification policy
      description: Update a Notification policy.
      operationId: notification-policies-update-a-notification-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                alert_type:
                  $ref: '#/components/schemas/alert_type'
                description:
                  $ref: '#/components/schemas/policies_components-schemas-description'
                enabled:
                  $ref: '#/components/schemas/policies_components-schemas-enabled'
                filters:
                  $ref: '#/components/schemas/components-schemas-filters'
                mechanisms:
                  $ref: '#/components/schemas/mechanisms'
                name:
                  $ref: '#/components/schemas/policies_components-schemas-name-2'
      responses:
        4xx:
          description: Update a Notification policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-id_response-2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a Notification policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-id_response-2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/custom_ns:
    get:
      tags:
      - Account-Level Custom Nameservers
      summary: List Account Custom Nameservers
      description: List an account's custom nameservers.
      operationId: account-level-custom-nameservers-list-account-custom-nameservers
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-ns_components-schemas-identifier'
      responses:
        4xx:
          description: List Account Custom Nameservers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/acns_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Account Custom Nameservers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/acns_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Account-Level Custom Nameservers
      summary: Add Account Custom Nameserver
      operationId: account-level-custom-nameservers-add-account-custom-nameserver
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-ns_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CustomNSInput'
      responses:
        4xx:
          description: Add Account Custom Nameserver response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/acns_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add Account Custom Nameserver response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/acns_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/custom_ns/{ns_name}:
    delete:
      tags:
      - Account-Level Custom Nameservers
      summary: Delete Account Custom Nameserver
      operationId: account-level-custom-nameservers-delete-account-custom-nameserver
      parameters:
      - name: ns_name
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/ns_name'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-ns_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Account Custom Nameserver response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/empty_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Account Custom Nameserver response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/empty_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/custom_ns/availability:
    get:
      tags:
      - Account-Level Custom Nameservers
      summary: Get Eligible Zones for Account Custom Nameservers
      operationId: account-level-custom-nameservers-get-eligible-zones-for-account-custom-nameservers
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-ns_components-schemas-identifier'
      responses:
        4xx:
          description: Get Eligible Zones for Account Custom Nameservers response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/availability_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Eligible Zones for Account Custom Nameservers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/availability_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/custom_ns/verify:
    post:
      tags:
      - Account-Level Custom Nameservers
      summary: Verify Account Custom Nameserver Glue Records
      operationId: account-level-custom-nameservers-verify-account-custom-nameserver-glue-records
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-ns_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Verify Account Custom Nameserver Glue Records response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/acns_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Verify Account Custom Nameserver Glue Records response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/acns_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices:
    get:
      tags:
      - Devices
      summary: List Devices
      description: List Enrolled Devices.
      operationId: devices-list-devices
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      responses:
        4xx:
          description: List Devices response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/devices_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Devices response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/devices_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/{uuid}:
    get:
      tags:
      - Devices
      summary: Device Details
      description: Fetch a single Device.
      operationId: devices-device-details
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      responses:
        4xx:
          description: Device Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Device Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/{uuid}/override_codes:
    get:
      tags:
      - Devices
      summary: List Admin Override code for device
      description: Fetch one-time use admin override code for a device. This relies
        on the Admin Override setting being enabled in your device configuration.
      operationId: devices-list-admin-override-code-for-device
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      responses:
        4xx:
          description: List Admin Override code for device response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/override_codes_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Admin Override code for device response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/override_codes_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/policies:
    get:
      tags:
      - Devices
      summary: List Device Settings Policies
      description: Lists the device settings policies for an account.
      operationId: devices-list-device-settings-policies
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      responses:
        4xx:
          description: List Device Settings Policies response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device_settings_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Device Settings Policies response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device_settings_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/policy:
    get:
      tags:
      - Devices
      summary: Get Default Device Settings Policy
      description: Get the default device settings policy for an account.
      operationId: devices-get-default-device-settings-policy
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      responses:
        4xx:
          description: Get Default Device Settings Policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/default_device_settings_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Default Device Settings Policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/default_device_settings_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Devices
      summary: Update Default Device Settings Policy
      description: Update the default device settings policy for an account.
      operationId: devices-update-default-device-settings-policy
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                allow_mode_switch:
                  $ref: '#/components/schemas/allow_mode_switch'
                allow_updates:
                  $ref: '#/components/schemas/allow_updates'
                allowed_to_leave:
                  $ref: '#/components/schemas/allowed_to_leave'
                auto_connect:
                  $ref: '#/components/schemas/auto_connect'
                captive_portal:
                  $ref: '#/components/schemas/captive_portal'
                disable_auto_fallback:
                  $ref: '#/components/schemas/disable_auto_fallback'
                service_mode_v2:
                  $ref: '#/components/schemas/service_mode_v2'
                support_url:
                  $ref: '#/components/schemas/support_url'
                switch_locked:
                  $ref: '#/components/schemas/switch_locked'
      responses:
        4xx:
          description: Update Default Device Settings Policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/default_device_settings_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Default Device Settings Policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/default_device_settings_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Devices
      summary: Create Device Settings Policy
      description: Create a device settings policy to be applied to certain devices
        matching the criteria.
      operationId: devices-create-device-settings-policy
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - precedence
              - match
              properties:
                allow_mode_switch:
                  $ref: '#/components/schemas/allow_mode_switch'
                allow_updates:
                  $ref: '#/components/schemas/allow_updates'
                allowed_to_leave:
                  $ref: '#/components/schemas/allowed_to_leave'
                auto_connect:
                  $ref: '#/components/schemas/auto_connect'
                captive_portal:
                  $ref: '#/components/schemas/captive_portal'
                disable_auto_fallback:
                  $ref: '#/components/schemas/disable_auto_fallback'
                enabled:
                  type: boolean
                  description: Whether the policy will be applied to matching devices.
                  example: true
                match:
                  $ref: '#/components/schemas/components-schemas-match'
                name:
                  type: string
                  description: The name of the device settings policy.
                  example: Allow Developers
                  maxLength: 100
                precedence:
                  $ref: '#/components/schemas/components-schemas-precedence'
                service_mode_v2:
                  $ref: '#/components/schemas/service_mode_v2'
                support_url:
                  $ref: '#/components/schemas/support_url'
                switch_locked:
                  $ref: '#/components/schemas/switch_locked'
      responses:
        4xx:
          description: Create Device Settings Policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device_settings_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Device Settings Policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device_settings_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/policy/{uuid}:
    delete:
      tags:
      - Devices
      summary: Delete Device Settings Policy
      description: Delete a device settings policy. Returns the remaining policies
        for the account.
      operationId: devices-delete-device-settings-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Device Settings Policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device_settings_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Device Settings Policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device_settings_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Devices
      summary: Get Device Settings Policy by ID
      description: Get the device settings policy by ID.
      operationId: devices-get-device-settings-policy-by-id
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      responses:
        4xx:
          description: Get Device Settings Policy by ID response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device_settings_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Device Settings Policy by ID response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device_settings_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Devices
      summary: Update Device Settings Policy
      description: Update a device settings policy.
      operationId: devices-update-device-settings-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                allow_mode_switch:
                  $ref: '#/components/schemas/allow_mode_switch'
                allow_updates:
                  $ref: '#/components/schemas/allow_updates'
                allowed_to_leave:
                  $ref: '#/components/schemas/allowed_to_leave'
                auto_connect:
                  $ref: '#/components/schemas/auto_connect'
                captive_portal:
                  $ref: '#/components/schemas/captive_portal'
                disable_auto_fallback:
                  $ref: '#/components/schemas/disable_auto_fallback'
                enabled:
                  type: boolean
                  description: Whether the policy will be applied to matching devices.
                  example: true
                match:
                  $ref: '#/components/schemas/components-schemas-match'
                name:
                  type: string
                  description: The name of the device settings policy.
                  example: Allow Developers
                  maxLength: 100
                precedence:
                  $ref: '#/components/schemas/components-schemas-precedence'
                service_mode_v2:
                  $ref: '#/components/schemas/service_mode_v2'
                support_url:
                  $ref: '#/components/schemas/support_url'
                switch_locked:
                  $ref: '#/components/schemas/switch_locked'
      responses:
        4xx:
          description: Update Device Settings Policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device_settings_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Device Settings Policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device_settings_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/policy/{uuid}/exclude:
    get:
      tags:
      - Devices
      summary: Get Split Tunnel Exclude List for a Device Settings Policy
      description: Get the list of routes excluded from the WARP client's tunnel for
        one specific device settings policy.
      operationId: devices-get-split-tunnel-exclude-list-for-a-device-settings-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      responses:
        4xx:
          description: Get Split Tunnel Exclude List for a Device Settings Policy
            response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/split_tunnel_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Split Tunnel Exclude List for a Device Settings Policy
            response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/split_tunnel_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Devices
      summary: Set Split Tunnel Exclude List for a Device Settings Policy
      description: Set the list of routes excluded from the WARP client's tunnel for
        one specific device settings policy.
      operationId: devices-set-split-tunnel-exclude-list-for-a-device-settings-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/split_tunnel'
      responses:
        4xx:
          description: Set Split Tunnel Exclude List for a Device Settings Policy
            response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/split_tunnel_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Set Split Tunnel Exclude List for a Device Settings Policy
            response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/split_tunnel_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/policy/{uuid}/fallback_domains:
    get:
      tags:
      - Devices
      summary: Get Local Domain Fallback List for a Device Settings Policy
      description: Get the list of domains to bypass Gateway for DNS resolution and
        instead use the specified server.
      operationId: devices-get-local-domain-fallback-list-for-a-device-settings-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      responses:
        4xx:
          description: Get Local Domain Fallback List for a Device Settings Policy
            response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fallback_domain_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Local Domain Fallback List for a Device Settings Policy
            response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fallback_domain_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Devices
      summary: Set Local Domain Fallback List for a Device Settings Policy
      description: Set the list of domains to bypass Gateway for DNS resolution and
        instead use the specified server.
      operationId: devices-set-local-domain-fallback-list-for-a-device-settings-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/fallback_domain'
      responses:
        4xx:
          description: Set Local Domain Fallback List for a Device Settings Policy
            response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fallback_domain_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Set Local Domain Fallback List for a Device Settings Policy
            response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fallback_domain_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/policy/{uuid}/include:
    get:
      tags:
      - Devices
      summary: Get Split Tunnel Include List for a Device Settings Policy
      description: Get the list of routes included in the WARP client's tunnel for
        one specific device settings policy.
      operationId: devices-get-split-tunnel-include-list-for-a-device-settings-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      responses:
        4xx:
          description: Get Split Tunnel Include List for a Device Settings Policy
            response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/split_tunnel_include_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Split Tunnel Include List for a Device Settings Policy
            response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/split_tunnel_include_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Devices
      summary: Set Split Tunnel Include List for a Device Settings Policy
      description: Set the list of routes included in the WARP client's tunnel for
        one specific device settings policy.
      operationId: devices-set-split-tunnel-include-list-for-a-device-settings-policy
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/split_tunnel_include'
      responses:
        4xx:
          description: Set Split Tunnel Include List for a Device Settings Policy
            response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/split_tunnel_include_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Set Split Tunnel Include List for a Device Settings Policy
            response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/split_tunnel_include_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/policy/exclude:
    get:
      tags:
      - Devices
      summary: Get Split Tunnel Exclude List
      description: Get the list of routes excluded from the WARP client's tunnel.
      operationId: devices-get-split-tunnel-exclude-list
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      responses:
        4xx:
          description: Get Split Tunnel Exclude List response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/split_tunnel_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Split Tunnel Exclude List response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/split_tunnel_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Devices
      summary: Set Split Tunnel Exclude List
      description: Set the list of routes excluded from the WARP client's tunnel.
      operationId: devices-set-split-tunnel-exclude-list
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/split_tunnel'
      responses:
        4xx:
          description: Set Split Tunnel Exclude List response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/split_tunnel_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Set Split Tunnel Exclude List response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/split_tunnel_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/policy/fallback_domains:
    get:
      tags:
      - Devices
      summary: Get Local Domain Fallback List
      description: Get the list of domains to bypass Gateway for DNS resolution and
        instead use the specified server.
      operationId: devices-get-local-domain-fallback-list
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      responses:
        4xx:
          description: Get Local Domain Fallback List response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fallback_domain_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Local Domain Fallback List response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fallback_domain_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Devices
      summary: Set Local Domain Fallback List
      description: Set the list of domains to bypass Gateway for DNS resolution and
        instead use the specified server.
      operationId: devices-set-local-domain-fallback-list
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/fallback_domain'
      responses:
        4xx:
          description: Set Local Domain Fallback List response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fallback_domain_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Set Local Domain Fallback List response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fallback_domain_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/policy/include:
    get:
      tags:
      - Devices
      summary: Get Split Tunnel Include List
      description: Get the list of routes included in the WARP client's tunnel.
      operationId: devices-get-split-tunnel-include-list
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      responses:
        4xx:
          description: Get Split Tunnel Include List response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/split_tunnel_include_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Split Tunnel Include List response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/split_tunnel_include_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Devices
      summary: Set Split Tunnel Include List
      description: Set the list of routes included in the WARP client's tunnel.
      operationId: devices-set-split-tunnel-include-list
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/split_tunnel_include'
      responses:
        4xx:
          description: Set Split Tunnel Include List response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/split_tunnel_include_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Set Split Tunnel Include List response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/split_tunnel_include_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/posture:
    get:
      tags:
      - Device Posture Rules
      summary: List Device Posture Rules
      description: List Device Posture Rules for an account.
      operationId: device-posture-rules-list-device-posture-rules
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-identifier'
      responses:
        4xx:
          description: List Device Posture Rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device-posture-rules_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Device Posture Rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device-posture-rules_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Device Posture Rules
      summary: Create Device Posture Rule
      description: Create a new Device Posture Rule.
      operationId: device-posture-rules-create-device-posture-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              properties:
                description:
                  $ref: '#/components/schemas/device-posture-rules_components-schemas-description'
                expiration:
                  $ref: '#/components/schemas/schemas-expiration'
                input:
                  $ref: '#/components/schemas/schemas-input'
                match:
                  $ref: '#/components/schemas/schemas-match'
                name:
                  $ref: '#/components/schemas/device-posture-rules_components-schemas-name'
                schedule:
                  $ref: '#/components/schemas/schedule'
                type:
                  $ref: '#/components/schemas/device-posture-rules_components-schemas-type'
      responses:
        4xx:
          description: Create Device Posture Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device-posture-rules_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Device Posture Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device-posture-rules_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/posture/{uuid}:
    delete:
      tags:
      - Device Posture Rules
      summary: Delete Device Posture Rule
      description: Delete a Device Posture Rule.
      operationId: device-posture-rules-delete-device-posture-rule
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Device Posture Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device-posture-rules_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Device Posture Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device-posture-rules_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Device Posture Rules
      summary: Device Posture Rules Details
      description: Fetch a single Device Posture Rule.
      operationId: device-posture-rules-device-posture-rules-details
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-identifier'
      responses:
        4xx:
          description: Device Posture Rules Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device-posture-rules_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Device Posture Rules Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device-posture-rules_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Device Posture Rules
      summary: Update Device Posture Rule
      description: Update a Device Posture Rule.
      operationId: device-posture-rules-update-device-posture-rule
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-rules_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              properties:
                description:
                  $ref: '#/components/schemas/device-posture-rules_components-schemas-description'
                expiration:
                  $ref: '#/components/schemas/schemas-expiration'
                input:
                  $ref: '#/components/schemas/schemas-input'
                match:
                  $ref: '#/components/schemas/schemas-match'
                name:
                  $ref: '#/components/schemas/device-posture-rules_components-schemas-name'
                schedule:
                  $ref: '#/components/schemas/schedule'
                type:
                  $ref: '#/components/schemas/device-posture-rules_components-schemas-type'
      responses:
        4xx:
          description: Update Device Posture Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device-posture-rules_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Device Posture Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device-posture-rules_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/posture/integration:
    get:
      tags:
      - Device Posture Integrations
      summary: List Device Posture Integrations
      description: List Device Posture Integrations for an account.
      operationId: device-posture-integrations-list-device-posture-integrations
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-integrations_components-schemas-identifier'
      responses:
        4xx:
          description: List Device Posture Integrations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device-posture-integrations_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Device Posture Integrations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device-posture-integrations_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Device Posture Integrations
      summary: Create Device Posture Integration
      description: Create a new Device Posture Integration.
      operationId: device-posture-integrations-create-device-posture-integration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-integrations_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              - interval
              - config
              properties:
                config:
                  $ref: '#/components/schemas/config_request'
                interval:
                  $ref: '#/components/schemas/schemas-interval'
                name:
                  $ref: '#/components/schemas/device-posture-integrations_components-schemas-name'
                type:
                  $ref: '#/components/schemas/device-posture-integrations_components-schemas-type'
      responses:
        4xx:
          description: Create Device Posture Integration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device-posture-integrations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Device Posture Integration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device-posture-integrations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/posture/integration/{uuid}:
    delete:
      tags:
      - Device Posture Integrations
      summary: Delete Device Posture Integration
      description: Delete a Device Posture Integration.
      operationId: device-posture-integrations-delete-device-posture-integration
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-integrations_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-integrations_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Device Posture Integration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device-posture-integrations_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Device Posture Integration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device-posture-integrations_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Device Posture Integrations
      summary: Device Posture Integration Details
      description: Fetch a single Device Posture Integration.
      operationId: device-posture-integrations-device-posture-integration-details
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-integrations_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-integrations_components-schemas-identifier'
      responses:
        4xx:
          description: Device Posture Integration Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device-posture-integrations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Device Posture Integration Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device-posture-integrations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Device Posture Integrations
      summary: Update Device Posture Integration
      description: Update a Device Posture Integration.
      operationId: device-posture-integrations-update-device-posture-integration
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-integrations_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/device-posture-integrations_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                config:
                  $ref: '#/components/schemas/config_request'
                interval:
                  $ref: '#/components/schemas/schemas-interval'
                name:
                  $ref: '#/components/schemas/device-posture-integrations_components-schemas-name'
                type:
                  $ref: '#/components/schemas/device-posture-integrations_components-schemas-type'
      responses:
        4xx:
          description: Update Device Posture Integration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/device-posture-integrations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Device Posture Integration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/device-posture-integrations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/revoke:
    post:
      tags:
      - Devices
      summary: Revoke Devices
      description: Revoke a list of devices.
      operationId: devices-revoke-devices
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/revoke_devices_request'
      responses:
        4xx:
          description: Revoke Devices response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Revoke Devices response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/settings:
    get:
      tags:
      - Zero Trust accounts
      summary: Get device settings for Zero Trust account
      description: Describes the current device settings Zero Trust account.
      operationId: zero-trust-accounts-get-device-settings-for-zero-trust-account
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/accounts_components-schemas-identifier'
      responses:
        4xx:
          description: Get device settings for Zero Trust account response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway-account-device-settings-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get device settings for Zero Trust account response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway-account-device-settings-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zero Trust accounts
      summary: Update device settings for the Zero Trust account
      description: Updates the current device settings for Zero Trust account.
      operationId: zero-trust-accounts-update-device-settings-for-the-zero-trust-account
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/accounts_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/gateway-account-device-settings'
      responses:
        4xx:
          description: Update device settings for the Zero Trust account response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway-account-device-settings-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update device settings for the Zero Trust account response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway-account-device-settings-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/devices/unrevoke:
    post:
      tags:
      - Devices
      summary: Unrevoke Devices
      description: Unrevoke a list of devices.
      operationId: devices-unrevoke-devices
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/devices_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/unrevoke_devices_request'
      responses:
        4xx:
          description: Unrevoke Devices response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Unrevoke Devices response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway:
    get:
      tags:
      - Zero Trust accounts
      summary: Get Zero Trust account information
      description: Get Zero Trust account information.
      operationId: zero-trust-accounts-get-zero-trust-account-information
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/accounts_components-schemas-identifier'
      responses:
        4xx:
          description: Get Zero Trust account information response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_account'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Zero Trust account information response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_account'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zero Trust accounts
      summary: Create Zero Trust account
      description: Create Zero Trust account with existing cloudflare account.
      operationId: zero-trust-accounts-create-zero-trust-account
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/accounts_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - account_id
              properties:
                account_id:
                  $ref: '#/components/schemas/cf_account_id'
      responses:
        4xx:
          description: Create Zero Trust account response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_account'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Zero Trust account response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_account'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway/app_types:
    get:
      tags:
      - Zero Trust Gateway Application and Application Type mappings
      summary: List Application and Application Type mappings
      description: List all Application and Application Type mappings.
      operationId: zero-trust-gateway-application-and-application-type-mappings-list-application-and-application-type-mappings
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Application and Application Type mappings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/app-types_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Application and Application Type mappings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/app-types_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway/configuration:
    get:
      tags:
      - Zero Trust accounts
      summary: Get Zero Trust account configuration
      description: Describes current Zero Trust account configuration.
      operationId: zero-trust-accounts-get-zero-trust-account-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/accounts_components-schemas-identifier'
      responses:
        4xx:
          description: Get Zero Trust account configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_account_config'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Zero Trust account configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_account_config'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zero Trust accounts
      summary: Update Zero Trust account configuration
      description: Updates the current Zero Trust account configuration.
      operationId: zero-trust-accounts-update-zero-trust-account-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/accounts_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/gateway-account-settings'
      responses:
        4xx:
          description: Update Zero Trust account configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway_account_config'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Zero Trust account configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway_account_config'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway/lists:
    get:
      tags:
      - Zero Trust Lists
      summary: List Zero Trust Lists
      description: List Zero Trust Lists for an account.
      operationId: zero-trust-lists-list-zero-trust-lists
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/lists_components-schemas-identifier'
      responses:
        4xx:
          description: List Zero Trust Lists response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/lists_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Zero Trust Lists response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zero Trust Lists
      summary: Create Zero Trust List
      description: Create a new Zero Trust List.
      operationId: zero-trust-lists-create-zero-trust-list
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/lists_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              properties:
                description:
                  $ref: '#/components/schemas/lists_components-schemas-description-2'
                items:
                  $ref: '#/components/schemas/schemas-items'
                name:
                  $ref: '#/components/schemas/lists_components-schemas-name-2'
                type:
                  $ref: '#/components/schemas/lists_components-schemas-type'
      responses:
        4xx:
          description: Create Zero Trust List response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_response_with_list_items'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Zero Trust List response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_response_with_list_items'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway/lists/{uuid}:
    delete:
      tags:
      - Zero Trust Lists
      summary: Delete Zero Trust List
      description: Delete a Zero Trust List.
      operationId: zero-trust-lists-delete-zero-trust-list
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/lists_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/lists_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Zero Trust List response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/lists_components-schemas-empty_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Zero Trust List response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_components-schemas-empty_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zero Trust Lists
      summary: Zero Trust List Details
      description: Fetch a single Zero Trust List.
      operationId: zero-trust-lists-zero-trust-list-details
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/lists_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/lists_components-schemas-identifier'
      responses:
        4xx:
          description: Zero Trust List Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/lists_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Zero Trust List Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zero Trust Lists
      summary: Patch Zero Trust List
      description: Append or remove an item from a configured Zero Trust List.
      operationId: zero-trust-lists-patch-zero-trust-list
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/lists_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/lists_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                append:
                  $ref: '#/components/schemas/schemas-items'
                remove:
                  type: array
                  description: A list of the item values you want to remove.
                  items:
                    $ref: '#/components/schemas/lists_components-schemas-value'
      responses:
        4xx:
          description: Patch Zero Trust List response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/lists_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch Zero Trust List response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zero Trust Lists
      summary: Update Zero Trust List
      description: Update a configured Zero Trust List.
      operationId: zero-trust-lists-update-zero-trust-list
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/lists_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/lists_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              properties:
                description:
                  $ref: '#/components/schemas/lists_components-schemas-description-2'
                name:
                  $ref: '#/components/schemas/lists_components-schemas-name-2'
      responses:
        4xx:
          description: Update Zero Trust List response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/lists_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Zero Trust List response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/lists_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway/lists/{uuid}/items:
    get:
      tags:
      - Zero Trust Lists
      summary: Zero Trust List Items
      description: Fetch all items of a single Zero Trust List.
      operationId: zero-trust-lists-zero-trust-list-items
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/lists_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/lists_components-schemas-identifier'
      responses:
        4xx:
          description: Zero Trust List Items response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/list_item_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Zero Trust List Items response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list_item_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway/locations:
    get:
      tags:
      - Zero Trust Gateway Locations
      summary: List Zero Trust Gateway Locations
      description: List Zero Trust Gateway Locations for an account.
      operationId: zero-trust-gateway-locations-list-zero-trust-gateway-locations
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/locations_components-schemas-identifier'
      responses:
        4xx:
          description: List Zero Trust Gateway Locations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/locations_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Zero Trust Gateway Locations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/locations_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zero Trust Gateway Locations
      summary: Create Zero Trust Gateway Location
      description: Create a new Zero Trust Gateway Location.
      operationId: zero-trust-gateway-locations-create-zero-trust-gateway-location
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/locations_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              properties:
                client_default:
                  $ref: '#/components/schemas/client-default'
                ecs_support:
                  $ref: '#/components/schemas/ecs-support'
                name:
                  $ref: '#/components/schemas/locations_components-schemas-name'
                networks:
                  $ref: '#/components/schemas/network'
      responses:
        4xx:
          description: Create Zero Trust Gateway Location response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/locations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Zero Trust Gateway Location response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/locations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway/locations/{uuid}:
    delete:
      tags:
      - Zero Trust Gateway Locations
      summary: Delete Zero Trust Gateway Location
      description: Delete a Zero Trust Gateway Location.
      operationId: zero-trust-gateway-locations-delete-zero-trust-gateway-location
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/locations_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/locations_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Zero Trust Gateway Location response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/locations_components-schemas-empty_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Zero Trust Gateway Location response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/locations_components-schemas-empty_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zero Trust Gateway Locations
      summary: Zero Trust Gateway Location Details
      description: Fetch a single Zero Trust Gateway Location.
      operationId: zero-trust-gateway-locations-zero-trust-gateway-location-details
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/locations_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/locations_components-schemas-identifier'
      responses:
        4xx:
          description: Zero Trust Gateway Location Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/locations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Zero Trust Gateway Location Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/locations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zero Trust Gateway Locations
      summary: Update Zero Trust Gateway Location
      description: Update a configured Zero Trust Gateway Location.
      operationId: zero-trust-gateway-locations-update-zero-trust-gateway-location
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/locations_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/locations_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              properties:
                client_default:
                  $ref: '#/components/schemas/client-default'
                ecs_support:
                  $ref: '#/components/schemas/ecs-support'
                name:
                  $ref: '#/components/schemas/locations_components-schemas-name'
                networks:
                  $ref: '#/components/schemas/network'
      responses:
        4xx:
          description: Update Zero Trust Gateway Location response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/locations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Zero Trust Gateway Location response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/locations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway/logging:
    get:
      tags:
      - Zero Trust accounts
      summary: Get logging settings for the Zero Trust account
      description: Describes the current logging settings for Zero Trust account.
      operationId: zero-trust-accounts-get-logging-settings-for-the-zero-trust-account
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/accounts_components-schemas-identifier'
      responses:
        4xx:
          description: Get logging settings for the Zero Trust account response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway-account-logging-settings-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get logging settings for the Zero Trust account response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway-account-logging-settings-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zero Trust accounts
      summary: Update logging settings for the Zero Trust account
      description: Updates the current logging settings for the Zero Trust accounty.
      operationId: zero-trust-accounts-update-logging-settings-for-the-zero-trust-account
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/accounts_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/gateway-account-logging-settings'
      responses:
        4xx:
          description: Update logging settings for the Zero Trust account response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/gateway-account-logging-settings-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update logging settings for the Zero Trust account response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/gateway-account-logging-settings-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway/proxy_endpoints:
    get:
      tags:
      - Zero Trust Gateway Proxy Endpoints
      summary: List Proxy Endpoints
      description: Fetch a single Zero Trust Gateway Proxy Endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-list-proxy-endpoints
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/proxy-endpoints_components-schemas-identifier'
      responses:
        4xx:
          description: List Proxy Endpoints response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/proxy-endpoints_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Proxy Endpoints response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/proxy-endpoints_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zero Trust Gateway Proxy Endpoints
      summary: Create Proxy Endpoint
      description: Create a new Zero Trust Gateway Proxy Endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-create-proxy-endpoint
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/proxy-endpoints_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - ips
              properties:
                ips:
                  $ref: '#/components/schemas/components-schemas-ips'
                name:
                  $ref: '#/components/schemas/proxy-endpoints_components-schemas-name'
                subdomain:
                  $ref: '#/components/schemas/schemas-subdomain'
      responses:
        4xx:
          description: Create Proxy Endpoint response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/proxy-endpoints_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Proxy Endpoint response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/proxy-endpoints_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway/proxy_endpoints/{uuid}:
    delete:
      tags:
      - Zero Trust Gateway Proxy Endpoints
      summary: Delete Proxy Endpoint
      description: Delete a Zero Trust Gateway Proxy Endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-delete-proxy-endpoint
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/proxy-endpoints_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/proxy-endpoints_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Proxy Endpoint response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/proxy-endpoints_components-schemas-empty_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Proxy Endpoint response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/proxy-endpoints_components-schemas-empty_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zero Trust Gateway Proxy Endpoints
      summary: Proxy Endpoint Details
      description: List Zero Trust Gateway Proxy Endpoints for an account.
      operationId: zero-trust-gateway-proxy-endpoints-proxy-endpoint-details
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/proxy-endpoints_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/proxy-endpoints_components-schemas-identifier'
      responses:
        4xx:
          description: Proxy Endpoint Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/proxy-endpoints_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Proxy Endpoint Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/proxy-endpoints_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zero Trust Gateway Proxy Endpoints
      summary: Update Proxy Endpoint
      description: Update a new Zero Trust Gateway Proxy Endpoint.
      operationId: zero-trust-gateway-proxy-endpoints-update-proxy-endpoint
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/proxy-endpoints_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/proxy-endpoints_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                ips:
                  $ref: '#/components/schemas/components-schemas-ips'
                name:
                  $ref: '#/components/schemas/proxy-endpoints_components-schemas-name'
                subdomain:
                  $ref: '#/components/schemas/schemas-subdomain'
      responses:
        4xx:
          description: Update Proxy Endpoint response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/proxy-endpoints_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Proxy Endpoint response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/proxy-endpoints_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway/rules:
    get:
      tags:
      - Zero Trust Gateway Rules
      summary: List Zero Trust Gateway Rules
      description: List Zero Trust Gateway Rules for an account.
      operationId: zero-trust-gateway-rules-list-zero-trust-gateway-rules
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-identifier'
      responses:
        4xx:
          description: List Zero Trust Gateway Rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rules_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Zero Trust Gateway Rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rules_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zero Trust Gateway Rules
      summary: Create Zero Trust Gateway Rule
      description: Create a new Zero Trust Gateway Rule.
      operationId: zero-trust-gateway-rules-create-zero-trust-gateway-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - action
              properties:
                action:
                  $ref: '#/components/schemas/rules_components-schemas-action-2'
                description:
                  $ref: '#/components/schemas/rules_components-schemas-description-2'
                device_posture:
                  $ref: '#/components/schemas/device_posture'
                enabled:
                  $ref: '#/components/schemas/rules_components-schemas-enabled-3'
                filters:
                  $ref: '#/components/schemas/schemas-filters'
                identity:
                  $ref: '#/components/schemas/identity'
                name:
                  $ref: '#/components/schemas/rules_components-schemas-name-2'
                precedence:
                  $ref: '#/components/schemas/schemas-precedence'
                rule_settings:
                  $ref: '#/components/schemas/rule-settings'
                traffic:
                  $ref: '#/components/schemas/traffic'
      responses:
        4xx:
          description: Create Zero Trust Gateway Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rules_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Zero Trust Gateway Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rules_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /accounts/{identifier}/gateway/rules/{uuid}:
    delete:
      tags:
      - Zero Trust Gateway Rules
      summary: Delete Zero Trust Gateway Rule
      description: Delete a Zero Trust Gateway Rule.
      operationId: zero-trust-gateway-rules-delete-zero-trust-gateway-rule
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Zero Trust Gateway Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rules_components-schemas-empty_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Zero Trust Gateway Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rules_components-schemas-empty_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zero Trust Gateway Rules
      summary: Zero Trust Gateway Rule Details
      description: Fetch a single Zero Trust Gateway Rule.
      operationId: zero-trust-gateway-rules-zero-trust-gateway-rule-details
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-identifier'
      responses:
        4xx:
          description: Zero Trust Gateway Rule Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rules_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Zero Trust Gateway Rule Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rules_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zero Trust Gateway Rules
      summary: Update Zero Trust Gateway Rule
      description: Update a configured Zero Trust Gateway Rule.
      operationId: zero-trust-gateway-rules-update-zero-trust-gateway-rule
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - action
              properties:
                action:
                  $ref: '#/components/schemas/rules_components-schemas-action-2'
                description:
                  $ref: '#/components/schemas/rules_components-schemas-description-2'
                device_posture:
                  $ref: '#/components/schemas/device_posture'
                enabled:
                  $ref: '#/components/schemas/rules_components-schemas-enabled-3'
                filters:
                  $ref: '#/components/schemas/schemas-filters'
                identity:
                  $ref: '#/components/schemas/identity'
                name:
                  $ref: '#/components/schemas/rules_components-schemas-name-2'
                precedence:
                  $ref: '#/components/schemas/schemas-precedence'
                rule_settings:
                  $ref: '#/components/schemas/rule-settings'
                traffic:
                  $ref: '#/components/schemas/traffic'
      responses:
        4xx:
          description: Update Zero Trust Gateway Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rules_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Zero Trust Gateway Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rules_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /certificates:
    get:
      tags:
      - Origin CA
      summary: List Certificates
      description: List all existing Origin CA certificates for a given zone. Use
        your Origin CA Key as your User Service Key when calling this endpoint ([see
        above](#requests)).
      operationId: origin-ca-list-certificates
      responses:
        4xx:
          description: List Certificates response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-certificate_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Certificates response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-certificate_response_collection'
      security:
      - user_service_key: []
      - api_token: []
    post:
      tags:
      - Origin CA
      summary: Create Certificate
      description: Create an Origin CA certificate. Use your Origin CA Key as your
        User Service Key when calling this endpoint ([see above](#requests)).
      operationId: origin-ca-create-certificate
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                csr:
                  $ref: '#/components/schemas/csr'
                hostnames:
                  $ref: '#/components/schemas/hostnames'
                request_type:
                  $ref: '#/components/schemas/request_type'
                requested_validity:
                  $ref: '#/components/schemas/requested_validity'
      responses:
        4xx:
          description: Create Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-certificate_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-certificate_response_single'
      security:
      - user_service_key: []
      - api_token: []
  /certificates/{identifier}:
    delete:
      tags:
      - Origin CA
      summary: Revoke Certificate
      description: Revoke an existing Origin CA certificate by its serial number.
        Use your Origin CA Key as your User Service Key when calling this endpoint
        ([see above](#requests)).
      operationId: origin-ca-revoke-certificate
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/certificates_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Revoke Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_response_single_id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Revoke Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_response_single_id'
      security:
      - user_service_key: []
      - api_token: []
    get:
      tags:
      - Origin CA
      summary: Get Certificate
      description: Get an existing Origin CA certificate by its serial number. Use
        your Origin CA Key as your User Service Key when calling this endpoint ([see
        above](#requests)).
      operationId: origin-ca-get-certificate
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/certificates_components-schemas-identifier'
      responses:
        4xx:
          description: Get Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-certificate_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-certificate_response_single'
      security:
      - user_service_key: []
      - api_token: []
  /ips:
    get:
      tags:
      - Cloudflare IPs
      summary: Cloudflare IP Details
      description: Get Cloudflare IPs.
      operationId: cloudflare-i-ps-cloudflare-ip-details
      responses:
        4xx:
          description: Cloudflare IP Details response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/ips'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Cloudflare IP Details response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/ips'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /memberships:
    get:
      tags:
      - User's Account Memberships
      summary: List Memberships
      description: List memberships of accounts the user can access.
      operationId: user'-s-account-memberships-list-memberships
      responses:
        4xx:
          description: List Memberships response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/collection_membership_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Memberships response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collection_membership_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /memberships/{identifier}:
    delete:
      tags:
      - User's Account Memberships
      summary: Delete Membership
      description: Remove the associated member from an account.
      operationId: user'-s-account-memberships-delete-membership
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/membership_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Membership response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - type: object
                    properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/membership_components-schemas-identifier'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Membership response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - type: object
                  properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/membership_components-schemas-identifier'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - User's Account Memberships
      summary: Membership Details
      description: Get a specific membership.
      operationId: user'-s-account-memberships-membership-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/membership_components-schemas-identifier'
      responses:
        4xx:
          description: Membership Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_membership_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Membership Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_membership_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - User's Account Memberships
      summary: Update Membership
      description: Accept or reject this account invitation.
      operationId: user'-s-account-memberships-update-membership
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/membership_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - status
              properties:
                status:
                  description: Whether to accept or reject this account invitation.
                  enum:
                  - accepted
                  - rejected
                  example: accepted
      responses:
        4xx:
          description: Update Membership response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_membership_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Membership response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_membership_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /organizations/{identifier}:
    get:
      tags:
      - Organizations (Deprecated)
      summary: Organization Details
      description: Get information about a specific organization that you are a member
        of.
      operationId: organizations-(-deprecated)-organization-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Organization Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_organization_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Organization Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_organization_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Organizations (Deprecated)
      summary: Edit Organization
      description: Update an existing Organization.
      operationId: organizations-(-deprecated)-edit-organization
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  $ref: '#/components/schemas/schemas-name'
      responses:
        4xx:
          description: Edit Organization response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_organization_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit Organization response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_organization_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /organizations/{organization_identifier}/audit_logs:
    get:
      tags:
      - Audit Logs
      summary: Get organization audit logs
      description: Gets a list of audit logs for an organization. The list can be
        filtered by who made the change, which zone was the change made on, and the
        timeframe of the change.
      operationId: audit-logs-get-organization-audit-logs
      parameters:
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get organization audit logs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/audit_logs_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get organization audit logs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/audit_logs_response_collection'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /organizations/{organization_identifier}/invites:
    get:
      tags:
      - Organization Invites
      summary: List Invitations
      description: List all invitations associated with an organization.
      operationId: organization-invites-list-invitations
      parameters:
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Invitations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/collection_invite_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Invitations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collection_invite_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Organization Invites
      summary: Create Invitation
      description: Invite a User to become a Member of an Organization.
      operationId: organization-invites-create-invitation
      parameters:
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - invited_member_email
              - roles
              properties:
                auto_accept:
                  type: boolean
                  description: When present and set to true, allows for the invited
                    user to be automatically accepted to the organization. No invitation
                    is sent.
                  default: false
                  example: true
                invited_member_email:
                  $ref: '#/components/schemas/invited_member_email'
                roles:
                  type: array
                  description: Array of Roles associated with the invited user.
                  example:
                  - id: 5a7805061c76ada191ed06f989cc3dac
                  - id: 9a7806061c88ada191ed06f989cc3dac
                  items:
                    type: object
                    required:
                    - id
                    properties:
                      description:
                        $ref: '#/components/schemas/description'
                      id:
                        $ref: '#/components/schemas/role_components-schemas-identifier'
                      name:
                        $ref: '#/components/schemas/components-schemas-name'
                      permissions:
                        $ref: '#/components/schemas/schemas-permissions'
      responses:
        4xx:
          description: Create Invitation response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_invite_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Invitation response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_invite_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /organizations/{organization_identifier}/invites/{identifier}:
    delete:
      tags:
      - Organization Invites
      summary: Cancel Invitation
      description: Cancel an existing invitation.
      operationId: organization-invites-cancel-invitation
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/invite_components-schemas-identifier'
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Cancel Invitation response failure
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    id:
                      $ref: '#/components/schemas/invite_components-schemas-identifier'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Cancel Invitation response
          content:
            application/json:
              schema:
                properties:
                  id:
                    $ref: '#/components/schemas/invite_components-schemas-identifier'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Organization Invites
      summary: Invitation Details
      description: Get the details of an invitation.
      operationId: organization-invites-invitation-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/invite_components-schemas-identifier'
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Invitation Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_invite_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Invitation Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_invite_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Organization Invites
      summary: Edit Invitation Roles
      description: Change the Roles of a Pending Invite.
      operationId: organization-invites-edit-invitation-roles
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/invite_components-schemas-identifier'
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                roles:
                  type: array
                  description: Array of Roles associated with the invited user.
                  items:
                    $ref: '#/components/schemas/role_components-schemas-identifier'
      responses:
        4xx:
          description: Edit Invitation Roles response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_invite_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit Invitation Roles response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_invite_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /organizations/{organization_identifier}/members:
    get:
      tags:
      - Organization Members
      summary: List Members
      description: List all members of a organization.
      operationId: organization-members-list-members
      parameters:
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/organization_components-schemas-identifier'
      responses:
        4xx:
          description: List Members response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/collection_member_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Members response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collection_member_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /organizations/{organization_identifier}/members/{identifier}:
    delete:
      tags:
      - Organization Members
      summary: Remove Member
      description: Remove a member from an organization.
      operationId: organization-members-remove-member
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/organization_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Remove Member response failure
          content:
            application/json:
              schema:
                allOf:
                - properties:
                    id:
                      $ref: '#/components/schemas/common_components-schemas-identifier'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Remove Member response
          content:
            application/json:
              schema:
                properties:
                  id:
                    $ref: '#/components/schemas/common_components-schemas-identifier'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Organization Members
      summary: Member Details
      description: Get information about a specific member of an organization.
      operationId: organization-members-member-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/organization_components-schemas-identifier'
      responses:
        4xx:
          description: Member Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_member_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Member Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_member_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Organization Members
      summary: Edit Member Roles
      description: Change the Roles of an Organization's Member.
      operationId: organization-members-edit-member-roles
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/organization_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                roles:
                  type: array
                  description: Array of Roles associated with this Member.
                  items:
                    $ref: '#/components/schemas/role_components-schemas-identifier'
      responses:
        4xx:
          description: Edit Member Roles response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_member_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit Member Roles response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_member_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /organizations/{organization_identifier}/railguns:
    get:
      tags:
      - Organization Railgun
      summary: List Railguns
      description: List, search, sort and filter your Railguns.
      operationId: organization-railgun-list-railguns
      parameters:
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Railguns response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Railguns response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_collection'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Organization Railgun
      summary: Create Railgun
      operationId: organization-railgun-create-railgun
      parameters:
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  $ref: '#/components/schemas/railgun_components-schemas-name'
      responses:
        4xx:
          description: Create Railgun response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Railgun response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /organizations/{organization_identifier}/railguns/{identifier}:
    delete:
      tags:
      - Organization Railgun
      summary: Delete Railgun
      description: Disable and delete a Railgun. This will immediately disable the
        Railgun for any connected zones.
      operationId: organization-railgun-delete-railgun
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Railgun response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single_id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Railgun response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single_id'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Organization Railgun
      summary: Railgun details
      operationId: organization-railgun-railgun-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Railgun details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Railgun details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Organization Railgun
      summary: Enable or disable a Railgun
      description: Enable or disable a Railgun for all zones connected to it.
      operationId: organization-railgun-enable-or-disable-a-railgun
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - enabled
              properties:
                enabled:
                  $ref: '#/components/schemas/railgun_components-schemas-enabled'
      responses:
        4xx:
          description: Enable or disable a Railgun response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Enable or disable a Railgun response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /organizations/{organization_identifier}/railguns/{identifier}/zones:
    get:
      tags:
      - Organization Railgun
      summary: Get Railgun zones
      description: Lists the zones that are currently using this Railgun.
      operationId: organization-railgun-get-railgun-zones
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Railgun zones response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - properties:
                      result:
                        type: array
                        items:
                          $ref: '#/components/schemas/components-schemas-zone'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Railgun zones response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/components-schemas-zone'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /organizations/{organization_identifier}/roles:
    get:
      tags:
      - Organization Roles
      summary: List Roles
      description: Get all available roles for an organization.
      operationId: organization-roles-list-roles
      parameters:
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/organization_components-schemas-identifier'
      responses:
        4xx:
          description: List Roles response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/collection_role_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Roles response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collection_role_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /organizations/{organization_identifier}/roles/{identifier}:
    get:
      tags:
      - Organization Roles
      summary: Role Details
      description: Get information about a specific role for an organization.
      operationId: organization-roles-role-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/role_components-schemas-identifier'
      - name: organization_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/organization_components-schemas-identifier'
      responses:
        4xx:
          description: Role Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_role_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Role Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_role_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/annotations/outages:
    get:
      tags:
      - Radar Annotations
      summary: Get outages annotations
      operationId: radar_get_AnnotationsOutages
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: offset
        in: query
        description: Number of objects to skip before grabbing results.
        schema:
          type: integer
          description: Number of objects to skip before grabbing results.
          default: 0
          example: 0
      - name: dateRange
        in: query
        description: Shorthand date ranges for the last X days - use when you don't
          need specific start and end dates.
        schema:
          type: string
          description: Shorthand date ranges for the last X days - use when you don't
            need specific start and end dates.
          enum:
          - 1d
          - 7d
          - 14d
          - 28d
          - 1dControl
          - 7dControl
          - 14dControl
          - 28dControl
          example: 7d
      - name: dateStart
        in: query
        description: Start of the date range (inclusive).
        schema:
          type: string
          format: date-time
          example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: End of the date range (inclusive).
        schema:
          type: string
          format: date-time
          example: "2022-09-15T00:00:00Z"
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      annotations:
                        type: array
                        items:
                          type: object
                          properties:
                            asns:
                              type: array
                              items:
                                type: integer
                                example: 189
                            dataSource:
                              type: string
                              example: ALL
                            description:
                              type: string
                              example: example
                            endDate:
                              type: string
                              example: "2022-09-08T10:00:28Z"
                            eventType:
                              type: string
                              example: OUTAGE
                            linkedUrl:
                              type: string
                              example: http://example.com
                            locations:
                              type: array
                              items:
                                type: string
                                example: MX
                            outage:
                              type: object
                              properties:
                                outageCause:
                                  type: string
                                  example: CABLE_CUT
                                outageType:
                                  type: string
                                  example: NATIONWIDE
                            scope:
                              type: string
                              example: Colima, Michoacán, México
                            startDate:
                              type: string
                              example: "2022-09-06T10:00:28Z"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/annotations/outages/locations:
    get:
      tags:
      - Radar Annotations
      summary: Get top outages annotations
      operationId: radar_get_AnnotationsOutagesTop
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: dateRange
        in: query
        description: Shorthand date ranges for the last X days - use when you don't
          need specific start and end dates.
        schema:
          type: string
          description: Shorthand date ranges for the last X days - use when you don't
            need specific start and end dates.
          enum:
          - 1d
          - 7d
          - 14d
          - 28d
          - 1dControl
          - 7dControl
          - 14dControl
          - 28dControl
          example: 7d
      - name: dateStart
        in: query
        description: Start of the date range (inclusive).
        schema:
          type: string
          format: date-time
          example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: End of the date range (inclusive).
        schema:
          type: string
          format: date-time
          example: "2022-09-15T00:00:00Z"
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      annotations:
                        type: array
                        items:
                          type: object
                          properties:
                            clientCountryAlpha2:
                              type: string
                              example: PT
                            clientCountryName:
                              type: string
                              example: Portugal
                            value:
                              type: string
                              example: "5"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/attacks/layer3/summary:
    get:
      tags:
      - Radar Attacks
      summary: Get a summary of layer 3 attacks
      description: Percentage distribution of network protocols in layer 3/4 attacks.
      operationId: radar_get_AttacksLayer3Summary
      parameters:
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                      example: ALL
                                    description:
                                      type: string
                                      example: Cable cut in Tonga
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                      example: OUTAGE
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                description: Adjusted end of date range.
                                example: "2022-09-17T10:22:57.555Z"
                              startTime:
                                type: string
                                format: date-time
                                description: Adjusted start of date range.
                                example: "2022-09-16T10:22:57.555Z"
                      summary_0:
                        type: object
                        properties:
                          gre:
                            type: string
                            example: "0.9"
                          icmp:
                            type: string
                            example: "0.1"
                          tcp:
                            type: string
                            example: "60"
                          udp:
                            type: string
                            example: "39"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/attacks/layer3/timeseries:
    get:
      tags:
      - Radar Attacks
      summary: Get layer 3 attacks time series
      description: Get layer 3/4 attacks change over time. Values are normalized using
        min-max by default, with the minimum set to 0. When asking for multiple time
        series, you can also get the percentual relative change of the 1st/main series,
        with respect to the 2nd/control series - for example, to get the relative
        change of this week from the previous week, the 1st series would have a date
        range of 7d, the 2nd, a date range of 7dControl, and the normalization would
        be set to PERCENTAGE_CHANGE.
      operationId: radar_get_AttacksLayer3Timeseries
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: attack
        in: query
        description: Array of L3/4 attack types.
        schema:
          type: array
          items:
            type: string
            description: Array of L3/4 attack types.
            enum:
            - udp
            - tcp
            - icmp
            - gre
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: normalization
        in: query
        description: Normalization method applied.
        schema:
          type: string
          description: Normalization method applied.
          enum:
          - PERCENTAGE_CHANGE
          - MIN0_MAX
          example: MIN0_MAX
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          aggInterval:
                            type: string
                            example: 1h
                          confidenceInfo:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                description: Adjusted end of date range.
                                example: "2022-09-17T10:22:57.555Z"
                              startTime:
                                type: string
                                format: date-time
                                description: Adjusted start of date range.
                                example: "2022-09-16T10:22:57.555Z"
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                description: Adjusted end of date range.
                                example: "2022-09-17T10:22:57.555Z"
                              startTime:
                                type: string
                                format: date-time
                                description: Adjusted start of date range.
                                example: "2022-09-16T10:22:57.555Z"
                          lastUpdated:
                            type: string
                            format: date-time
                            example: "2022-09-15T00:00:00Z"
                      series:
                        type: object
                        properties:
                          timestamps:
                            type: array
                            items:
                              type: string
                              format: date-time
                              example: "2022-09-15T00:00:00Z"
                          values:
                            type: array
                            items:
                              type: string
                              example: 0.56
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/attacks/layer3/timeseries_groups:
    get:
      tags:
      - Radar Attacks
      summary: Get layer 3 attacks by network protocol, over time
      description: Get percentage of what type of network protocols are used in layer
        3/4 attacks, over time.
      operationId: radar_get_AttacksLayer3TimeseriesGroups
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          aggInterval:
                            type: string
                            example: 1h
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                      example: ALL
                                    description:
                                      type: string
                                      example: Cable cut in Tonga
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                      example: OUTAGE
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                description: Adjusted end of date range.
                                example: "2022-09-17T10:22:57.555Z"
                              startTime:
                                type: string
                                format: date-time
                                description: Adjusted start of date range.
                                example: "2022-09-16T10:22:57.555Z"
                          lastUpdated:
                            type: string
                            format: date-time
                            example: "2022-09-15T00:00:00Z"
                      serie_0:
                        type: object
                        properties:
                          gre:
                            type: array
                            items:
                              type: string
                              example: "0.9"
                          icmp:
                            type: array
                            items:
                              type: string
                              example: "0.1"
                          tcp:
                            type: array
                            items:
                              type: string
                              example: "70"
                          timeseries:
                            type: array
                            items:
                              type: string
                          udp:
                            type: array
                            items:
                              type: string
                              example: "29"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/attacks/layer7/summary:
    get:
      tags:
      - Radar Attacks
      summary: Get a summary of layer 7 attacks
      description: Percentage distribution of mitigation techniques in layer 7 attacks.
      operationId: radar_get_AttacksLayer7Summary
      parameters:
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                      example: ALL
                                    description:
                                      type: string
                                      example: Cable cut in Tonga
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                      example: OUTAGE
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                description: Adjusted end of date range.
                                example: "2022-09-17T10:22:57.555Z"
                              startTime:
                                type: string
                                format: date-time
                                description: Adjusted start of date range.
                                example: "2022-09-16T10:22:57.555Z"
                      summary_0:
                        type: object
                        properties:
                          gre:
                            type: string
                            example: "0.1"
                          icmp:
                            type: string
                            example: "0.9"
                          tcp:
                            type: string
                            example: "65"
                          udp:
                            type: string
                            example: "34"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/attacks/layer7/timeseries:
    get:
      tags:
      - Radar Attacks
      summary: Get attacks layer 7 time series
      description: Get layer 7 attacks change over time. Values are normalized using
        min-max by default, with the minimum set to 0. When asking for multiple time
        series, you can also get the percentage relative change of the first/main
        series, with respect to the second/control series - for example, to get the
        relative change of this week from the previous week, the first series would
        have a date range of `7d`, the second, a date range of `7dControl`, and the
        normalization would be set to `PERCENTAGE_CHANGE`.
      operationId: radar_get_AttacksLayer7Timeseries
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: attack
        in: query
        description: Array of L7 attack types.
        schema:
          type: array
          items:
            type: string
            description: Array of L7 attack types.
            enum:
            - ddos
            - waf
            - bot_management
            - access_rules
            - ip_reputation
            - api_shield
            - data_loss_prevention
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: normalization
        in: query
        description: Normalization method applied.
        schema:
          type: string
          description: Normalization method applied.
          enum:
          - PERCENTAGE_CHANGE
          - MIN0_MAX
          example: MIN0_MAX
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          aggInterval:
                            type: string
                            example: 1h
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                      example: ALL
                                    description:
                                      type: string
                                      example: Cable cut in Tonga
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                      example: OUTAGE
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                description: Adjusted end of date range.
                                example: "2022-09-17T10:22:57.555Z"
                              startTime:
                                type: string
                                format: date-time
                                description: Adjusted start of date range.
                                example: "2022-09-16T10:22:57.555Z"
                          lastUpdated:
                            type: string
                            format: date-time
                            example: "2022-09-15T00:00:00Z"
                      series:
                        type: object
                        properties:
                          timestamps:
                            type: array
                            items:
                              type: string
                              format: date-time
                              example: "2022-09-15T00:00:00Z"
                          values:
                            type: array
                            items:
                              type: string
                              example: 0.56
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/attacks/layer7/timeseries_groups:
    get:
      tags:
      - Radar Attacks
      summary: Get layer 7 attacks by mitigation technique, over time
      description: Get percentage of what type of mitigation techniques are used to
        block layer 7 attacks, over time.
      operationId: radar_get_AttacksLayer7TimeseriesGroups
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          aggInterval:
                            type: string
                            example: 1h
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                      example: ALL
                                    description:
                                      type: string
                                      example: Cable cut in Tonga
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                      example: OUTAGE
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                description: Adjusted end of date range.
                                example: "2022-09-17T10:22:57.555Z"
                              startTime:
                                type: string
                                format: date-time
                                description: Adjusted start of date range.
                                example: "2022-09-16T10:22:57.555Z"
                          lastUpdated:
                            type: string
                            format: date-time
                            example: "2022-09-15T00:00:00Z"
                      serie_0:
                        type: object
                        properties:
                          gre:
                            type: array
                            items:
                              type: string
                              example: "5"
                          icmp:
                            type: array
                            items:
                              type: string
                              example: "5"
                          tcp:
                            type: array
                            items:
                              type: string
                              example: "60"
                          timeseries:
                            type: array
                            items:
                              type: string
                              format: date-time
                              example: "2022-09-15T00:00:00Z"
                          udp:
                            type: array
                            items:
                              type: string
                              example: "30"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/attacks/layer7/top/ases/origin:
    get:
      tags:
      - Radar Attacks
      summary: Get layer 7 top origin ASes
      description: Get the top origin ASes by layer 7 attacks. Values are a percentage
        out of the total layer 7 attacks. The origin location is determined by the
        client IP.
      operationId: radar_get_AttacksLayer7TopOriginASes
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: location
        in: query
        description: Array of locations (alpha-2 country codes).
        schema:
          type: array
          items:
            type: string
            description: Array of locations (alpha-2 country codes).
            example: US
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            originAsn:
                              type: number
                              example: 16509
                            originAsnName:
                              type: string
                              example: AMAZON-02
                            rank:
                              type: string
                              example: "1"
                            value:
                              type: string
                              example: "0.73996"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/attacks/layer7/top/attacks:
    get:
      tags:
      - Radar Attacks
      summary: Get layer 7 top attack pairs (origin and target locations)
      description: Get the top attacks from origin to target location. Values are
        a percentage out of the total layer 7 attacks (with billing country). The
        attack magnitude can be defined by the number of mitigated requests or by
        the number of zones affected. You can optionally limit the number of attacks
        per origin/target location (useful if all the top attacks are from or to the
        same location).
      operationId: radar_get_AttacksLayer7TopAttacks
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: magnitude
        in: query
        description: Attack magnitude can be defined by total requests mitigated or
          by total zones attacked.
        schema:
          type: string
          description: Attack magnitude can be defined by total requests mitigated
            or by total zones attacked.
          enum:
          - AFFECTED_ZONES
          - MITIGATED_REQUESTS
          example: mitigated_requests
      - name: limitDirection
        in: query
        description: Array of attack origin/target location attack limits. Together
          with `limitPerLocation`, limits how many objects will be fetched per origin/target
          location.
        schema:
          type: array
          items:
            type: string
            description: Array of attack origin/target location attack limits. Together
              with `limitPerLocation`, limits how many objects will be fetched per
              origin/target location.
            enum:
            - ORIGIN
            - TARGET
            example: origin
      - name: limitPerLocation
        in: query
        description: Limit the number of attacks per origin/target (see `limitDirection`
          parameter) location.
        schema:
          type: array
          items:
            type: integer
            description: Limit the number of attacks per origin/target (see `limitDirection`
              parameter) location.
            default: 10
            example: 10
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            originCountryAlpha2:
                              type: string
                              example: US
                            originCountryName:
                              type: string
                              example: United States
                            rank:
                              type: string
                              example: "1"
                            targetCountryAlpha2:
                              type: string
                              example: PT
                            targetCountryName:
                              type: string
                              example: Portugal
                            value:
                              type: string
                              example: "0.73996"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/attacks/layer7/top/locations/origin:
    get:
      tags:
      - Radar Attacks
      summary: Get layer 7 top origin locations
      description: Get the top origin locations of and by layer 7 attacks. Values
        are a percentage out of the total layer 7 attacks. The origin location is
        determined by the client IP.
      operationId: radar_get_AttacksLayer7TopOriginLocations
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            originCountryAlpha2:
                              type: string
                              example: US
                            originCountryName:
                              type: string
                              example: United States
                            rank:
                              type: string
                              example: "1"
                            value:
                              type: string
                              example: "0.73996"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/attacks/layer7/top/locations/target:
    get:
      tags:
      - Radar Attacks
      summary: Get layer 7 top target locations
      description: Get the top target locations of and by layer 7 attacks. Values
        are a percentage out of the total layer 7 attacks. The target location is
        determined by the attacked zone's billing country, when available.
      operationId: radar_get_AttacksLayer7TopTargetLocations
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            rank:
                              type: string
                              example: "1"
                            targetCountryAlpha2:
                              type: string
                              example: US
                            targetCountryName:
                              type: string
                              example: United States
                            value:
                              type: string
                              example: "0.73996"
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/bgp/leaks/events:
    get:
      tags:
      - Radar BGP
      summary: Get BGP route leak events
      description: Get the BGP route leak events.
      operationId: radar_get_BGPRouteLeakEvents
      parameters:
      - name: page
        in: query
        description: Current page number, starting from 1
        schema:
          type: integer
          description: Current page number, starting from 1
          default: 1
      - name: per_page
        in: query
        description: Number of entries per page
        schema:
          type: integer
          description: Number of entries per page
          default: 50
      - name: leakAsn
        in: query
        description: The leaking AS of a route leak event
        schema:
          type: integer
          description: The leaking AS of a route leak event
      - name: involvedAsn
        in: query
        description: ASN that is causing or affected by a route leak event
        schema:
          type: integer
          description: ASN that is causing or affected by a route leak event
      - name: dateRange
        in: query
        description: For example, use `7d` to get route leak events happened within
          this week.
        schema:
          type: string
          description: For example, use `7d` to get route leak events happened within
            this week.
          enum:
          - 1d
          - 7d
          - 14d
          - 28d
          default: 1d
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      data:
                        type: object
                        properties:
                          asn_info:
                            type: array
                            items:
                              type: object
                              properties:
                                asn:
                                  type: integer
                                org_name:
                                  type: string
                          events:
                            type: array
                            items:
                              type: object
                              properties:
                                detected_ts:
                                  type: string
                                finished:
                                  type: boolean
                                id:
                                  type: integer
                                leak_asn:
                                  type: integer
                                leak_count:
                                  type: integer
                                leak_seg:
                                  type: array
                                  items:
                                    type: integer
                                leak_type:
                                  type: integer
                                max_ts:
                                  type: string
                                min_ts:
                                  type: string
                                origin_count:
                                  type: integer
                                peer_count:
                                  type: integer
                                prefix_count:
                                  type: integer
                  result_info:
                    type: object
                    properties:
                      count:
                        type: integer
                      page:
                        type: integer
                      per_page:
                        type: integer
                      total_count:
                        type: integer
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/bgp/timeseries:
    get:
      tags:
      - Radar BGP
      summary: Get BGP time series
      description: Gets BGP updates change over time. Raw values are returned. When
        requesting updates of an autonomous system (AS), only BGP updates of type
        announcement are returned.
      operationId: radar_get_BgpTimeseries
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: prefix
        in: query
        description: Network prefix, IPv4 or IPv6.
        schema:
          type: string
          description: Network prefix, IPv4 or IPv6.
          example: 1.1.1.0/24
      - name: updateType
        in: query
        description: Array of BGP update types.
        schema:
          type: array
          items:
            type: string
            description: Array of BGP update types.
            enum:
            - ANNOUNCEMENT
            - WITHDRAWAL
            example: ANNOUNCEMENT
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          aggInterval:
                            type: string
                            example: 1h
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                      example: ALL
                                    description:
                                      type: string
                                      example: Cable cut in Tonga
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                      example: OUTAGE
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                description: Adjusted end of date range.
                                example: "2022-09-17T10:22:57.555Z"
                              startTime:
                                type: string
                                format: date-time
                                description: Adjusted start of date range.
                                example: "2022-09-16T10:22:57.555Z"
                          lastUpdated:
                            type: string
                            format: date-time
                            example: "2022-09-15T00:00:00Z"
                      series:
                        type: object
                        properties:
                          timestamps:
                            type: array
                            items:
                              type: string
                              format: date-time
                              example: "2022-09-15T00:00:00Z"
                          values:
                            type: array
                            items:
                              type: string
                              example: 0.56
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/bgp/top/ases:
    get:
      tags:
      - Radar BGP
      summary: Get top autonomous systems
      description: Get the top autonomous systems (AS) by BGP updates (announcements
        only). Values are a percentage out of the total updates.
      operationId: radar_get_BGPTopASes
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: prefix
        in: query
        description: Array of BGP network prefixes.
        schema:
          type: array
          items:
            type: string
            description: Array of BGP network prefixes.
            example: 1.1.1.0/24
      - name: updateType
        in: query
        description: Array of BGP update types.
        schema:
          type: array
          items:
            type: string
            description: Array of BGP update types.
            enum:
            - ANNOUNCEMENT
            - WITHDRAWAL
            example: ANNOUNCEMENT
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                description: Adjusted end of date range.
                                example: "2022-09-17T10:22:57.555Z"
                              startTime:
                                type: string
                                format: date-time
                                description: Adjusted start of date range.
                                example: "2022-09-16T10:22:57.555Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            ASName:
                              type: string
                              example: Apple-Engineering
                            asn:
                              type: string
                              example: "714"
                            value:
                              type: string
                              description: Percentage of updates by this AS out of
                                the total updates by all autonomous systems.
                              example: "0.73996"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/bgp/top/prefixes:
    get:
      tags:
      - Radar BGP
      summary: Get top prefixes
      description: Get the top network prefixes by BGP updates. Values are a percentage
        out of the total BGP updates.
      operationId: radar_get_BGPTopPrefixes
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: updateType
        in: query
        description: Array of BGP update types.
        schema:
          type: array
          items:
            type: string
            description: Array of BGP update types.
            enum:
            - ANNOUNCEMENT
            - WITHDRAWAL
            example: ANNOUNCEMENT
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                description: Adjusted end of date range.
                                example: "2022-09-17T10:22:57.555Z"
                              startTime:
                                type: string
                                format: date-time
                                description: Adjusted start of date range.
                                example: "2022-09-16T10:22:57.555Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            prefix:
                              type: string
                              example: 2804:77cc:8000::/33
                            value:
                              type: string
                              example: "0.73996"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/datasets:
    get:
      tags:
      - Radar Datasets
      summary: Get Datasets
      description: Get a list of datasets.
      operationId: radar_get_DatasetList
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: offset
        in: query
        description: Number of objects to skip before grabbing results.
        schema:
          type: integer
          description: Number of objects to skip before grabbing results.
          default: 0
          example: 0
      - name: datasetType
        in: query
        description: Dataset type.
        schema:
          type: string
          description: Dataset type.
          enum:
          - RANKING_BUCKET
          - REPORT
          default: RANKING_BUCKET
          example: RANKING_BUCKET
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      datasets:
                        type: array
                        items:
                          type: object
                          properties:
                            description:
                              type: string
                              example: This dataset contains a list of the op 20000
                                domains globally
                            id:
                              type: integer
                              example: 3
                            meta:
                              type: object
                            tags:
                              type: array
                              items:
                                type: string
                                example: global
                            title:
                              type: string
                              example: Top bucket 20000 domains
                            type:
                              type: string
                              example: RANKING_BUCKET
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/datasets/{alias}:
    get:
      tags:
      - Radar Datasets
      summary: Get Dataset csv Stream
      description: Get the content of a dataset.
      operationId: radar_get_DatasetStream
      parameters:
      - name: alias
        in: path
        description: Dataset alias or id
        required: true
        schema:
          type: string
          description: Dataset alias or id
          example: year-in-review
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/datasets/download:
    post:
      tags:
      - Radar Datasets
      summary: Get Dataset download url
      description: Get a url to download a single dataset.
      operationId: radar_post_DatasetDownload
      parameters:
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                datasetId:
                  type: integer
                  example: 3
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  dataset:
                    type: object
                    properties:
                      url:
                        type: string
                        example: https://example.com/download
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/dns/top/ases:
    get:
      tags:
      - Radar DNS
      summary: Get top autonomous systems by DNS queries.
      description: Get top autonomous systems by DNS queries made to Cloudflare's
        public DNS resolver.
      operationId: radar_get_DnsTopAses
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: domain
        in: query
        description: Array of domain names.
        required: true
        schema:
          type: array
          items:
            type: string
            description: Array of domain names.
            example: google.com
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientASN:
                              type: string
                              example: "174"
                            clientASName:
                              type: string
                              example: Cogent-174
                            value:
                              type: string
                              example: "65"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/dns/top/locations:
    get:
      tags:
      - Radar DNS
      summary: Get top locations by DNS queries
      description: Get top locations by DNS queries made to Cloudflare's public DNS
        resolver.
      operationId: radar_get_DnsTopLocations
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: domain
        in: query
        description: Array of domain names.
        required: true
        schema:
          type: array
          items:
            type: string
            description: Array of domain names.
            example: google.com
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientCountryAlpha2:
                              type: string
                              example: PT
                            clientCountryName:
                              type: string
                              example: Portugal
                            value:
                              type: string
                              example: "65"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/entities/asns:
    get:
      tags:
      - Radar Entities
      summary: Get autonomous systems
      description: Gets a list of autonomous systems (AS).
      operationId: radar_get_ASNsList
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: offset
        in: query
        description: Number of objects to skip before grabbing results.
        schema:
          type: integer
          description: Number of objects to skip before grabbing results.
          default: 0
          example: 0
      - name: asn
        in: query
        description: Comma separated list of ASNs.
        schema:
          type: string
          description: Comma separated list of ASNs.
          example: 174,7922
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  ases:
                    type: array
                    items:
                      type: object
                      properties:
                        aka:
                          type: string
                        asn:
                          type: integer
                          example: 714
                        name:
                          type: string
                          example: Apple Inc.
                        nameLong:
                          type: string
                        website:
                          type: string
                          example: https://www.apple.com/support/systemstatus/
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/entities/asns/{asn}:
    get:
      tags:
      - Radar Entities
      summary: Get autonomous system (AS) by ID
      description: Get the requested autonomous system information. A confidence level
        below `5` indicates a low level of confidence in the traffic data - normally
        this happens because Cloudflare has a small amount of traffic from/to this
        AS).
      operationId: radar_get_ASNId
      parameters:
      - name: asn
        in: path
        description: Autonomous System Number (ASN).
        required: true
        schema:
          type: integer
          description: Autonomous System Number (ASN).
          example: 3
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      asn:
                        type: object
                        properties:
                          aka:
                            type: string
                          asn:
                            type: integer
                            example: 714
                          confidenceLevel:
                            type: integer
                            example: 5
                          country:
                            type: string
                          name:
                            type: string
                            example: Apple Inc.
                          nameLong:
                            type: string
                          related:
                            type: array
                            items:
                              type: object
                              properties:
                                aka:
                                  type: string
                                  example: ""
                                asn:
                                  type: integer
                                  example: 174
                                name:
                                  type: string
                                  example: Cogent-174
                          website:
                            type: string
                            example: https://www.apple.com/support/systemstatus/
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/entities/asns/ip:
    get:
      tags:
      - Radar Entities
      summary: Get autonomous system information by IP address
      operationId: radar_get_ASNIp
      parameters:
      - name: ip
        in: query
        description: IP address.
        required: true
        schema:
          type: string
          description: IP address.
          example: 1.1.1.1
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      asn:
                        type: object
                        properties:
                          aka:
                            type: string
                          asn:
                            type: integer
                            example: 714
                          country:
                            type: string
                          name:
                            type: string
                            example: Apple Inc.
                          nameLong:
                            type: string
                          related:
                            type: array
                            items:
                              type: object
                              properties:
                                aka:
                                  type: string
                                asn:
                                  type: integer
                                name:
                                  type: string
                          website:
                            type: string
                            example: https://www.apple.com/support/systemstatus/
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/entities/locations:
    get:
      tags:
      - Radar Entities
      summary: Get locations
      description: Get a list of locations.
      operationId: radar_get_LocationsList
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: offset
        in: query
        description: Number of objects to skip before grabbing results.
        schema:
          type: integer
          description: Number of objects to skip before grabbing results.
          default: 0
          example: 0
      - name: location
        in: query
        description: Comma separated list of locations.
        schema:
          type: string
          description: Comma separated list of locations.
          example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      locations:
                        type: array
                        items:
                          type: object
                          properties:
                            alpha2:
                              type: string
                              example: AF
                            latitude:
                              type: string
                              example: 33.939116
                            longitude:
                              type: string
                              example: 67.709953
                            name:
                              type: string
                              example: Afghanistan
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/entities/locations/{location}:
    get:
      tags:
      - Radar Entities
      summary: Get location
      description: Get the requested location information. A confidence level below
        `5` indicates a low level of confidence in the traffic data - normally this
        happens because Cloudflare has a small amount of traffic from/to this location).
      operationId: radar_get_LocationsOne
      parameters:
      - name: location
        in: path
        description: Alpha-2 country code.
        required: true
        schema:
          type: string
          description: Alpha-2 country code.
          example: US
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      location:
                        type: object
                        properties:
                          alpha2:
                            type: string
                            example: AF
                          confidenceLvel:
                            type: integer
                            example: 5
                          latitude:
                            type: string
                            example: 33.939116
                          longitude:
                            type: string
                            example: 67.709953
                          name:
                            type: string
                            example: Afghanistan
                          region:
                            type: string
                            example: Middle East
                          subregion:
                            type: string
                            example: Southern Asia
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/summary/bot_class:
    get:
      tags:
      - Radar Http
      summary: Get a summary of bot classes
      description: Percentage distribution of traffic classified as automated or human.
      operationId: radar_get_SummaryBotClass
      parameters:
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      summary_0:
                        type: object
                        properties:
                          bot:
                            type: string
                            example: "35"
                          human:
                            type: string
                            example: "65"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/summary/device_type:
    get:
      tags:
      - Radar Http
      summary: Get a summary of device types
      description: Percentage distribution of traffic per device type.
      operationId: radar_get_SummaryDeviceType
      parameters:
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      summary_0:
                        type: object
                        properties:
                          desktop:
                            type: string
                            example: "65"
                          mobile:
                            type: string
                            example: "30"
                          other:
                            type: string
                            example: "5"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/summary/http_protocol:
    get:
      tags:
      - Radar Http
      summary: Get a summary of HTTP protocols
      description: Percentage distribution of traffic per HTTP protocol.
      operationId: radar_get_SummaryHttpProtocol
      parameters:
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      summary_0:
                        type: object
                        properties:
                          http:
                            type: string
                            example: "99"
                          https:
                            type: string
                            example: "1"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/summary/http_version:
    get:
      tags:
      - Radar Http
      summary: Get a summary of HTTP versions
      description: Percentage distribution of traffic per HTTP protocol version.
      operationId: radar_get_SummaryHttpVersion
      parameters:
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      summary_0:
                        type: object
                        properties:
                          HTTP/1.x:
                            type: string
                            example: "1"
                          HTTP/2:
                            type: string
                            example: "39"
                          HTTP/3:
                            type: string
                            example: "60"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/summary/ip_version:
    get:
      tags:
      - Radar Http
      summary: Get a summary of IP versions
      description: Percentage distribution of traffic per IP protocol version.
      operationId: radar_get_SummaryIpVersion
      parameters:
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      summary_0:
                        type: object
                        properties:
                          IPv4:
                            type: string
                            example: "65"
                          IPv6:
                            type: string
                            example: "35"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/summary/tls_version:
    get:
      tags:
      - Radar Http
      summary: Get a summary of TLS versions
      description: Percentage distribution of traffic per TLS protocol version.
      operationId: radar_get_SummaryTLSVersion
      parameters:
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      summary_0:
                        type: object
                        properties:
                          TLS 1.0:
                            type: string
                            example: "0.5"
                          TLS 1.1:
                            type: string
                            example: "0.5"
                          TLS 1.2:
                            type: string
                            example: "60"
                          TLS 1.3:
                            type: string
                            example: "10"
                          TLS QUIC:
                            type: string
                            example: "29"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/timeseries/bot_class:
    get:
      tags:
      - Radar Http
      summary: Get time series of bot classes
      description: Percentage distribution of traffic classified as automated or human
        over time.
      operationId: radar_get_TimeseriesBotClass
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      serie_0:
                        type: object
                        properties:
                          bot:
                            type: array
                            items:
                              type: string
                          human:
                            type: array
                            items:
                              type: string
                          timestamps:
                            type: array
                            items:
                              type: string
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/timeseries/browser:
    get:
      tags:
      - Radar Http
      summary: Get time series of user agents
      description: Percentage distribution of traffic of the top user agents in the
        selected time range, over time.
      operationId: radar_get_TimeseriesBrowsers
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: limitPerGroup
        in: query
        description: Limit the number of objects (eg browsers) to the top items over
          the time range.
        schema:
          type: integer
          description: Limit the number of objects (eg browsers) to the top items
            over the time range.
          default: 10
          example: 2
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      serie_0:
                        type: object
                        properties:
                          <browser name>:
                            type: array
                            items:
                              type: string
                          timestamps:
                            type: array
                            items:
                              type: string
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/timeseries/browser_family:
    get:
      tags:
      - Radar Http
      summary: Get time series of user agents aggregated in families
      description: Percentage distribution of traffic of the top user agents aggregated
        in families in the selected time range, over time.
      operationId: radar_get_TimeseriesBrowserFamilies
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      serie_0:
                        type: object
                        properties:
                          <browser name>:
                            type: array
                            items:
                              type: string
                          timestamps:
                            type: array
                            items:
                              type: string
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/timeseries/device_type:
    get:
      tags:
      - Radar Http
      summary: Get time series of device types
      description: Percentage distribution of traffic per device type over time.
      operationId: radar_get_TimeseriesDeviceType
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      serie_0:
                        type: object
                        properties:
                          desktop:
                            type: array
                            items:
                              type: string
                          mobile:
                            type: array
                            items:
                              type: string
                          other:
                            type: array
                            items:
                              type: string
                          timestamps:
                            type: array
                            items:
                              type: string
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/timeseries/http_protocol:
    get:
      tags:
      - Radar Http
      summary: Get time series of HTTP protocols
      description: Percentage distribution of traffic per HTTP protocol over time.
      operationId: radar_get_TimeseriesHttpProtocol
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      serie_0:
                        type: object
                        properties:
                          http:
                            type: array
                            items:
                              type: string
                          https:
                            type: array
                            items:
                              type: string
                          timestamps:
                            type: array
                            items:
                              type: string
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/timeseries/http_version:
    get:
      tags:
      - Radar Http
      summary: Get time series of HTTP versions
      description: Percentage distribution of traffic per HTTP protocol version over
        time.
      operationId: radar_get_TimeseriesHttpVersion
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      serie_0:
                        type: object
                        properties:
                          HTTP/1.x:
                            type: array
                            items:
                              type: string
                          HTTP/2:
                            type: array
                            items:
                              type: string
                          HTTP/3:
                            type: array
                            items:
                              type: string
                          timestamps:
                            type: array
                            items:
                              type: string
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/timeseries/ip_version:
    get:
      tags:
      - Radar Http
      summary: Get time series of IP versions
      description: Percentage distribution of traffic per IP protocol version over
        time.
      operationId: radar_get_TimeseriesIpVersion
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      serie_0:
                        type: object
                        properties:
                          IPv4:
                            type: array
                            items:
                              type: string
                          IPv6:
                            type: array
                            items:
                              type: string
                          timestamps:
                            type: array
                            items:
                              type: string
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/timeseries/tls_version:
    get:
      tags:
      - Radar Http
      summary: Get time series of TLS versions
      description: Percentage distribution of traffic per TLS protocol version over
        time.
      operationId: radar_get_TimeseriesTLSVersion
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                      serie_0:
                        type: object
                        properties:
                          TLS 1.0:
                            type: array
                            items:
                              type: string
                          TLS 1.1:
                            type: array
                            items:
                              type: string
                          TLS 1.2:
                            type: array
                            items:
                              type: string
                          TLS 1.3:
                            type: array
                            items:
                              type: string
                          TLS QUIC:
                            type: array
                            items:
                              type: string
                          timestamps:
                            type: array
                            items:
                              type: string
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/ases:
    get:
      tags:
      - Radar Http
      summary: Get top autonomous systems by HTTP requests
      description: Get the top autonomous systems (AS) by HTTP traffic. Values are
        a percentage out of the total traffic.
      operationId: radar_get_HttpTopASes
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientASN:
                              type: string
                              example: "3243"
                            clientASName:
                              type: string
                              example: MEO
                            value:
                              type: string
                              example: "3"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/ases/bot_class/{bot_class}:
    get:
      tags:
      - Radar Http
      summary: Get top autonomous systems by bot class
      description: Get the top autonomous systems (AS), by HTTP traffic, of the requested
        bot class. These two categories use Cloudflare's bot score - refer to [Bot
        Scores](https://developers.cloudflare.com/bots/concepts/bot-score) for more
        information. Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopASesByBotClass
      parameters:
      - name: bot_class
        in: path
        description: Bot class.
        required: true
        schema:
          type: string
          description: Bot class.
          enum:
          - LIKELY_AUTOMATED
          - LIKELY_HUMAN
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientASN:
                              type: string
                              example: "3243"
                            clientASName:
                              type: string
                              example: MEO
                            value:
                              type: string
                              example: "3"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/ases/device_type/{device_type}:
    get:
      tags:
      - Radar Http
      summary: Get top autonomous systems by device type
      description: Get the top autonomous systems (AS), by HTTP traffic, of the requested
        device type. Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopASesByDeviceType
      parameters:
      - name: device_type
        in: path
        description: Device type.
        required: true
        schema:
          type: string
          description: Device type.
          enum:
          - DESKTOP
          - MOBILE
          - OTHER
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientASN:
                              type: string
                              example: "3243"
                            clientASName:
                              type: string
                              example: MEO
                            value:
                              type: string
                              example: "3"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/ases/http_protocol/{http_protocol}:
    get:
      tags:
      - Radar Http
      summary: Get top autonomous systems by HTTP protocol
      description: Get the top autonomous systems (AS), by HTTP traffic, of the requested
        HTTP protocol. Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopASesByHTTPProtocol
      parameters:
      - name: http_protocol
        in: path
        description: HTTP Protocol.
        required: true
        schema:
          type: string
          description: HTTP Protocol.
          enum:
          - HTTP
          - HTTPS
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientASN:
                              type: string
                              example: "3243"
                            clientASName:
                              type: string
                              example: MEO
                            value:
                              type: string
                              example: "3"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/ases/http_version/{http_version}:
    get:
      tags:
      - Radar Http
      summary: Get top autonomous systems by HTTP version
      description: Get the top autonomous systems (AS), by HTTP traffic, of the requested
        HTTP protocol version. Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopASesByHTTPVersion
      parameters:
      - name: http_version
        in: path
        description: HTTP version.
        required: true
        schema:
          type: string
          description: HTTP version.
          enum:
          - HTTPv1
          - HTTPv2
          - HTTPv3
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientASN:
                              type: string
                              example: "3243"
                            clientASName:
                              type: string
                              example: MEO
                            value:
                              type: string
                              example: "3"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/ases/ip_version/{ip_version}:
    get:
      tags:
      - Radar Http
      summary: Get top autonomous systems by IP version
      description: Get the top autonomous systems, by HTTP traffic, of the requested
        IP protocol version. Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopASesByIpVersion
      parameters:
      - name: ip_version
        in: path
        description: IP version.
        required: true
        schema:
          type: string
          description: IP version.
          enum:
          - IPv4
          - IPv6
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientASN:
                              type: string
                              example: "3243"
                            clientASName:
                              type: string
                              example: MEO
                            value:
                              type: string
                              example: "3"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/ases/tls_version/{tls_version}:
    get:
      tags:
      - Radar Http
      summary: Get top autonomous systems by TLS version
      description: Get the top autonomous systems (AS), by HTTP traffic, of the requested
        TLS protocol version. Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopASesByTLSVersion
      parameters:
      - name: tls_version
        in: path
        description: TLS version.
        required: true
        schema:
          type: string
          description: TLS version.
          enum:
          - TLSv1_0
          - TLSv1_1
          - TLSv1_2
          - TLSv1_3
          - TLSvQUIC
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientASN:
                              type: string
                              example: "3243"
                            clientASName:
                              type: string
                              example: MEO
                            value:
                              type: string
                              example: "3"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/browser_families:
    get:
      tags:
      - Radar Http
      summary: Get top user agents aggregated in families by HTTP requests
      description: Get the top user agents aggregated in families by HTTP traffic.
        Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopBrowserFamilies
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            <browser name>:
                              type: string
                            value:
                              type: string
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/browsers:
    get:
      tags:
      - Radar Http
      summary: Get top user agents by HTTP requests
      description: Get the top user agents by HTTP traffic. Values are a percentage
        out of the total traffic.
      operationId: radar_get_HttpTopBrowsers
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            <browser name>:
                              type: string
                            value:
                              type: string
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/locations:
    get:
      tags:
      - Radar Http
      summary: Get top locations by HTTP requests
      description: Get the top locations by HTTP traffic. Values are a percentage
        out of the total traffic.
      operationId: radar_get_HttpTopLocations
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientCountryAlpha2:
                              type: string
                              example: US
                            clientCountryName:
                              type: string
                              example: United States
                            value:
                              type: string
                              example: "65"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/locations/bot_class/{bot_class}:
    get:
      tags:
      - Radar Http
      summary: Get top locations by bot class
      description: Get the top locations, by HTTP traffic, of the requested bot class.
        These two categories use Cloudflare's bot score - refer to [Bot scores])https://developers.cloudflare.com/bots/concepts/bot-score).
        Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopLocationsByBotClass
      parameters:
      - name: bot_class
        in: path
        description: Bot class.
        required: true
        schema:
          type: string
          description: Bot class.
          enum:
          - LIKELY_AUTOMATED
          - LIKELY_HUMAN
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientCountryAlpha2:
                              type: string
                              example: US
                            clientCountryName:
                              type: string
                              example: United States
                            value:
                              type: string
                              example: "65"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/locations/device_type/{device_type}:
    get:
      tags:
      - Radar Http
      summary: Get top locations by device type
      description: Get the top locations, by HTTP traffic, of the requested device
        type. Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopLocationsByDeviceType
      parameters:
      - name: device_type
        in: path
        description: Device type.
        required: true
        schema:
          type: string
          description: Device type.
          enum:
          - DESKTOP
          - MOBILE
          - OTHER
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientCountryAlpha2:
                              type: string
                              example: US
                            clientCountryName:
                              type: string
                              example: United States
                            value:
                              type: string
                              example: "65"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/locations/http_protocol/{http_protocol}:
    get:
      tags:
      - Radar Http
      summary: Get top locations by HTTP protocol
      description: Get the top locations, by HTTP traffic, of the requested HTTP protocol.
        Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopLocationsByHTTPProtocol
      parameters:
      - name: http_protocol
        in: path
        description: HTTP Protocol.
        required: true
        schema:
          type: string
          description: HTTP Protocol.
          enum:
          - HTTP
          - HTTPS
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientCountryAlpha2:
                              type: string
                              example: US
                            clientCountryName:
                              type: string
                              example: United States
                            value:
                              type: string
                              example: "65"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/locations/http_version/{http_version}:
    get:
      tags:
      - Radar Http
      summary: Get top locations by HTTP version
      description: Get the top locations, by HTTP traffic, of the requested HTTP protocol.
        Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopLocationsByHTTPVersion
      parameters:
      - name: http_version
        in: path
        description: HTTP version.
        required: true
        schema:
          type: string
          description: HTTP version.
          enum:
          - HTTPv1
          - HTTPv2
          - HTTPv3
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientCountryAlpha2:
                              type: string
                              example: US
                            clientCountryName:
                              type: string
                              example: United States
                            value:
                              type: string
                              example: "65"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/locations/ip_version/{ip_version}:
    get:
      tags:
      - Radar Http
      summary: Get top locations by IP version
      description: Get the top locations, by HTTP traffic, of the requested IP protocol
        version. Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopLocationsByIpVersion
      parameters:
      - name: ip_version
        in: path
        description: IP version.
        required: true
        schema:
          type: string
          description: IP version.
          enum:
          - IPv4
          - IPv6
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientCountryAlpha2:
                              type: string
                              example: US
                            clientCountryName:
                              type: string
                              example: United States
                            value:
                              type: string
                              example: "65"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/http/top/locations/tls_version/{tls_version}:
    get:
      tags:
      - Radar Http
      summary: Get top locations by TLS version
      description: Get the top locations, by HTTP traffic, of the requested TLS protocol
        version. Values are a percentage out of the total traffic.
      operationId: radar_get_HttpTopLocationsByTLSVersion
      parameters:
      - name: tls_version
        in: path
        description: TLS version.
        required: true
        schema:
          type: string
          description: TLS version.
          enum:
          - TLSv1_0
          - TLSv1_1
          - TLSv1_2
          - TLSv1_3
          - TLSvQUIC
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: botClass
        in: query
        description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
        schema:
          type: array
          items:
            type: string
            description: Filter for bot class. Refer to [Bot Groupings](https://developers.cloudflare.com/bots/concepts/bot-score#bot-groupings)
            enum:
            - LIKELY_AUTOMATED
            - LIKELY_HUMAN
            example: LIKELY_AUTOMATED
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientCountryAlpha2:
                              type: string
                              example: US
                            clientCountryName:
                              type: string
                              example: United States
                            value:
                              type: string
                              example: "65"
                  success:
                    type: boolean
                    example: true
        "404":
          description: Not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Not Found
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/netflows/timeseries:
    get:
      tags:
      - Radar Netflows
      summary: Get NetFlow time series
      description: Get network traffic change over time. Values are normalized using
        min-max by default, with the minimum set to 0. When asking for multiple time
        series, you can also get the percentage relative change of the first/main
        series, with respect to the second/control series - for example, to get the
        relative change of this week from the previous week, the first series would
        have a date range of `7d`, the second, a date range of `7dControl`, and the
        normalization would be set to `PERCENTAGE_CHANGE`.
      operationId: radar_get_Timeseries
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: product
        in: query
        description: Array of network traffic product types.
        schema:
          type: array
          items:
            type: string
            description: Array of network traffic product types.
            enum:
            - http
            - all
            example: all
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: normalization
        in: query
        description: Normalization method applied.
        schema:
          type: string
          description: Normalization method applied.
          enum:
          - PERCENTAGE_CHANGE
          - MIN0_MAX
          example: MIN0_MAX
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          aggInterval:
                            type: string
                            example: 1h
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                      example: ALL
                                    description:
                                      type: string
                                      example: Cable cut in Tonga
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                      example: OUTAGE
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                description: Adjusted end of date range.
                                example: "2022-09-17T10:22:57.555Z"
                              startTime:
                                type: string
                                format: date-time
                                description: Adjusted start of date range.
                                example: "2022-09-16T10:22:57.555Z"
                          lastUpdated:
                            type: string
                            format: date-time
                            example: "2022-09-15T00:00:00Z"
                      series:
                        type: object
                        properties:
                          timestamps:
                            type: array
                            items:
                              type: string
                              format: date-time
                              example: "2022-09-15T00:00:00Z"
                          values:
                            type: array
                            items:
                              type: string
                              example: 0.56
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/netflows/top/ases:
    get:
      tags:
      - Radar Netflows
      summary: Get top autonomous systems
      description: Get the top autonomous systems (AS) by network traffic. Values
        are a percentage out of the total network traffic.
      operationId: radar_get_NetflowsTopASes
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientASN:
                              type: number
                              example: 16509
                            clientASName:
                              type: string
                              example: AMAZON-02
                            value:
                              type: string
                              example: "0.73996"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/netflows/top/locations:
    get:
      tags:
      - Radar Netflows
      summary: Get top locations
      description: Get the top locations by network traffic. Values are a percentage
        out of the total network traffic.
      operationId: radar_get_NetflowsTopLocations
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            clientCountryAlpha2:
                              type: string
                              example: US
                            clientCountryName:
                              type: string
                              example: United States
                            value:
                              type: string
                              example: "0.73996"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/ranking/timeseries:
    get:
      tags:
      - Radar Ranking
      summary: Get Domains Rank time series
      description: Gets Domains Rank updates change over time. Raw values are returned.
      operationId: radar_get_RankingTimeseries
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: location
        in: query
        description: Array of locations (alpha-2 country codes).
        schema:
          type: array
          items:
            type: string
            description: Array of locations (alpha-2 country codes).
            example: US
      - name: domains
        in: query
        description: Array of comma separated list of domains names.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of domains names.
            example: google.com,facebook.com
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                description: Adjusted end of date range.
                                example: "2022-09-17T10:22:57.555Z"
                              startTime:
                                type: string
                                format: date-time
                                description: Adjusted start of date range.
                                example: "2022-09-16T10:22:57.555Z"
                      serie_0:
                        type: object
                        properties:
                          <domain name>:
                            type: array
                            items:
                              type: integer
                              example: 2
                          timestamps:
                            type: array
                            items:
                              type: string
                              example: "2022-09-02"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/ranking/top:
    get:
      tags:
      - Radar Ranking
      summary: Get Domains Rank top
      description: Gets Top Domains Rank globally or by country.
      operationId: radar_get_RankingTop
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: location
        in: query
        description: Array of locations (alpha-2 country codes).
        schema:
          type: array
          items:
            type: string
            description: Array of locations (alpha-2 country codes).
            example: US
      - name: date
        in: query
        description: Array of dates to filter the ranking.
        schema:
          type: array
          items:
            type: string
            format: date
            description: Array of dates to filter the ranking.
            example: "2022-09-19"
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          top_0:
                            type: object
                            properties:
                              date:
                                type: string
                                example: "2022-09-19"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            domain:
                              type: string
                              example: google.com
                            rank:
                              type: integer
                              example: 1
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/search/global:
    get:
      tags:
      - Radar Search
      summary: Search for locations, autonomous systems (AS) and reports
      description: Lets you search for locations, autonomous systems (AS) and reports.
      operationId: radar_get_SearchGlobal
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: query
        in: query
        description: Search for locations, AS and reports
        required: true
        schema:
          type: string
          description: Search for locations, AS and reports
          example: United
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: array
                    items:
                      type: object
                      properties:
                        code:
                          type: string
                          example: "13335"
                        name:
                          type: string
                          example: Cloudflare
                        type:
                          type: string
                          example: asn
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/specialevents:
    get:
      tags:
      - Radar Special Events
      summary: List Special Events
      description: Get a list of Special Events.
      operationId: radar_get_SpecialEventsList
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: offset
        in: query
        description: Number of objects to skip before grabbing results.
        schema:
          type: integer
          description: Number of objects to skip before grabbing results.
          default: 0
          example: 0
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      specialEvents:
                        type: array
                        items:
                          type: object
                          properties:
                            alias:
                              type: string
                              example: euro2020
                            categories:
                              type: array
                              items:
                                type: object
                                properties:
                                  categoryAlias:
                                    type: string
                                    example: streaming
                                  location:
                                    type: string
                                    example: GLOBAL
                            description:
                              type: string
                              example: The 2020 UEFA European Football Championship
                            id:
                              type: integer
                              example: 1
                            title:
                              type: string
                              example: Euro2020
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/specialevents/{eventAlias}:
    get:
      tags:
      - Radar Special Events
      summary: Get a Single Special Events
      description: Get a single Special Event.
      operationId: radar_get_SpecialEventsGet
      parameters:
      - name: eventAlias
        in: path
        description: Special Event alias
        required: true
        schema:
          type: string
          description: Special Event alias
          example: eurovision-2022
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      specialEvent:
                        type: object
                        properties:
                          alias:
                            type: string
                            example: euro2020
                          categories:
                            type: array
                            items:
                              type: object
                              properties:
                                categoryAlias:
                                  type: string
                                  example: streaming
                                location:
                                  type: string
                                  example: GLOBAL
                          description:
                            type: string
                            example: The 2020 UEFA European Football Championship
                          id:
                            type: integer
                            example: 1
                          title:
                            type: string
                            example: Euro2020
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/specialevents/{eventAlias}/{categoryAlias}:
    get:
      tags:
      - Radar Special Events
      summary: Get Special Events time series
      operationId: radar_get_TimeseriesSpecialEvents
      parameters:
      - name: aggInterval
        in: query
        description: Aggregation interval results should be returned in (for example,
          in 15 minutes or 1 hour intervals).
        schema:
          type: string
          description: Aggregation interval results should be returned in (for example,
            in 15 minutes or 1 hour intervals).
          enum:
          - 15m
          - 1h
          - 1d
          example: 1h
      - name: name
        in: query
        description: Name that will be used to name the series in response.
        schema:
          type: string
          description: Name that will be used to name the series in response.
          example: main_series
      - name: dateStart
        in: query
        description: Start of the date range (inclusive).
        schema:
          type: string
          format: date-time
          example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: End of the date range (inclusive).
        schema:
          type: string
          format: date-time
          example: "2022-09-15T00:00:00Z"
      - name: location
        in: query
        description: Location Alpha2 code.
        schema:
          type: string
          description: Location Alpha2 code.
          example: US
      - name: eventAlias
        in: path
        description: Special Event alias
        required: true
        schema:
          type: string
          description: Special Event alias
          example: eurovision-2022
      - name: categoryAlias
        in: path
        description: Special Event Category alias
        required: true
        schema:
          type: string
          description: Special Event Category alias
          example: videos
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      serie_0:
                        type: object
                        properties:
                          timestamps:
                            type: array
                            items:
                              type: string
                              format: date-time
                              example: "2022-09-15T00:00:00Z"
                          values:
                            type: array
                            items:
                              type: string
                              example: 0.56
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/verified_bots/top/bots:
    get:
      tags:
      - Radar Verified Bots
      summary: Get top verified bots by HTTP requests
      description: Get top verified bots by HTTP requests, with owner and category.
      operationId: radar_get_HttpTopVerifiedBots
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            botCategory:
                              type: string
                              example: Search Engine Crawler
                            botName:
                              type: string
                              example: GoogleBot
                            botOwner:
                              type: string
                              example: Google
                            value:
                              type: string
                              example: "29.034407"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /radar/verified_bots/top/categories:
    get:
      tags:
      - Radar Verified Bots
      summary: Get top verified bot categories by HTTP requests
      description: Get top verified bot categories by HTTP requests, along with their
        corresponding percentage, over the total verified bot HTTP requests.
      operationId: radar_get_HttpTopVerifiedBotCategories
      parameters:
      - name: limit
        in: query
        description: Limit the number of objects in the response.
        schema:
          type: integer
          description: Limit the number of objects in the response.
          default: 5
          example: 5
      - name: name
        in: query
        description: Array of names that will be used to name the series in responses.
        schema:
          type: array
          items:
            type: string
            description: Array of names that will be used to name the series in responses.
            example: main_series
      - name: dateRange
        in: query
        description: For example, use `7d` and `7dControl` to compare this week with
          the previous week. Use this parameter or set specific start and end dates
          (`dateStart` and `dateEnd` parameters).
        schema:
          type: array
          items:
            type: string
            description: For example, use `7d` and `7dControl` to compare this week
              with the previous week. Use this parameter or set specific start and
              end dates (`dateStart` and `dateEnd` parameters).
            enum:
            - 1d
            - 7d
            - 14d
            - 28d
            - 1dControl
            - 7dControl
            - 14dControl
            - 28dControl
      - name: dateStart
        in: query
        description: Array of datetimes to filter the start of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: dateEnd
        in: query
        description: Array of datetimes to filter the end of a series.
        schema:
          type: array
          items:
            type: string
            format: date-time
            example: "2022-09-15T00:00:00Z"
      - name: asn
        in: query
        description: Array of comma separated list of ASNs, start with `-` to exclude
          from results. For example, `[-174, 3356]` excludes results from AS174, but
          includes results from AS3356.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of ASNs, start with `-` to
              exclude from results. For example, `[-174, 3356]` excludes results from
              AS174, but includes results from AS3356.
            example: "15169"
      - name: location
        in: query
        description: Array of comma separated list of locations (alpha-2 country codes).
          Start with `-` to exclude from results. For example, `[-US, PT]` excludes
          results from the US, but includes results from PT.
        schema:
          type: array
          items:
            type: string
            description: Array of comma separated list of locations (alpha-2 country
              codes). Start with `-` to exclude from results. For example, `[-US,
              PT]` excludes results from the US, but includes results from PT.
            example: US,CA
      - name: format
        in: query
        description: Format results are returned in.
        schema:
          type: string
          description: Format results are returned in.
          enum:
          - json
          - csv
          example: json
      responses:
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    type: object
                    properties:
                      meta:
                        type: object
                        properties:
                          confidenceInfo:
                            type: object
                            properties:
                              annotations:
                                type: array
                                items:
                                  type: object
                                  properties:
                                    dataSource:
                                      type: string
                                    description:
                                      type: string
                                    endTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                                    eventType:
                                      type: string
                                    startTime:
                                      type: string
                                      format: date-time
                                      example: "2022-09-15T00:00:00Z"
                              level:
                                type: integer
                          dateRange:
                            type: object
                            properties:
                              endTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                              startTime:
                                type: string
                                format: date-time
                                example: "2022-09-15T00:00:00Z"
                      top_0:
                        type: array
                        items:
                          type: object
                          properties:
                            botCategory:
                              type: string
                              example: Search
                            value:
                              type: string
                              example: "65"
                  success:
                    type: boolean
                    example: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /railguns:
    get:
      tags:
      - Railgun
      summary: List Railguns
      description: List, search, sort and filter your Railguns.
      operationId: railgun-list-railguns
      responses:
        4xx:
          description: List Railguns response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Railguns response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Railgun
      summary: Create Railgun
      operationId: railgun-create-railgun
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  $ref: '#/components/schemas/railgun_components-schemas-name'
      responses:
        4xx:
          description: Create Railgun response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Railgun response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /railguns/{identifier}:
    delete:
      tags:
      - Railgun
      summary: Delete a Railgun
      description: Disable and delete a Railgun. This will immediately disable that
        Railgun for any connected zones.
      operationId: railgun-delete-a-railgun
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a Railgun response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single_id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a Railgun response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single_id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Railgun
      summary: Railgun details
      operationId: railgun-railgun-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      responses:
        4xx:
          description: Railgun details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Railgun details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Railgun
      summary: Enable or disable a Railgun
      description: Enable or disable a Railgun for all zones connected to it.
      operationId: railgun-enable-or-disable-a-railgun
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - enabled
              properties:
                enabled:
                  $ref: '#/components/schemas/railgun_components-schemas-enabled'
      responses:
        4xx:
          description: Enable or disable a Railgun response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Enable or disable a Railgun response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /railguns/{identifier}/zones:
    get:
      tags:
      - Railgun
      summary: List Railgun zones
      description: List the zones that are currently using this Railgun.
      operationId: railgun-list-railgun-zones
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier'
      responses:
        4xx:
          description: List Railgun zones response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - properties:
                      result:
                        type: array
                        items:
                          $ref: '#/components/schemas/components-schemas-zone'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Railgun zones response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/components-schemas-zone'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user:
    get:
      tags:
      - User
      summary: User Details
      operationId: user-user-details
      responses:
        4xx:
          description: User Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_user_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: User Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_user_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - User
      summary: Edit User
      description: Edit part of your user details.
      operationId: user-edit-user
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                country:
                  $ref: '#/components/schemas/country'
                first_name:
                  $ref: '#/components/schemas/first_name'
                last_name:
                  $ref: '#/components/schemas/last_name'
                telephone:
                  $ref: '#/components/schemas/telephone'
                zipcode:
                  $ref: '#/components/schemas/zipcode'
      responses:
        4xx:
          description: Edit User response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_user_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit User response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_user_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/audit_logs:
    get:
      tags:
      - Audit Logs
      summary: Get user audit logs
      description: Gets a list of audit logs for a user account. The list can be filtered
        by who made the change, which zone was the change made on, and the timeframe
        of the change.
      operationId: audit-logs-get-user-audit-logs
      responses:
        4xx:
          description: Get user audit logs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/audit_logs_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get user audit logs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/audit_logs_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/billing/history:
    get:
      tags:
      - User Billing History
      summary: Billing History Details
      description: Accesses your billing history object.
      operationId: user-billing-history-billing-history-details
      responses:
        4xx:
          description: Billing History Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billing_history_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Billing History Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/billing_history_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/billing/profile:
    get:
      tags:
      - User Billing Profile
      summary: Billing Profile Details
      description: Accesses your billing profile object.
      operationId: user-billing-profile-billing-profile-details
      responses:
        4xx:
          description: Billing Profile Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/billing_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Billing Profile Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/billing_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/firewall/access_rules/rules:
    get:
      tags:
      - IP Access rules for a user
      summary: List IP Access rules
      description: Fetches IP Access rules of the user. You can filter the results
        using several optional parameters.
      operationId: ip-access-rules-for-a-user-list-ip-access-rules
      responses:
        4xx:
          description: List IP Access rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List IP Access rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - IP Access rules for a user
      summary: Create an IP Access rule
      description: |-
        Creates a new IP Access rule for all zones owned by the current user.

        Note: To create an IP Access rule that applies to a specific zone, refer to the [IP Access rules for a zone](#ip-access-rules-for-a-zone) endpoints.
      operationId: ip-access-rules-for-a-user-create-an-ip-access-rule
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - mode
              - configuration
              properties:
                configuration:
                  $ref: '#/components/schemas/schemas-configuration'
                mode:
                  $ref: '#/components/schemas/schemas-mode'
                notes:
                  $ref: '#/components/schemas/notes'
      responses:
        4xx:
          description: Create an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/firewall/access_rules/rules/{identifier}:
    delete:
      tags:
      - IP Access rules for a user
      summary: Delete an IP Access rule
      description: |-
        Deletes an IP Access rule at the user level.

        Note: Deleting a user-level rule will affect all zones owned by the user.
      operationId: ip-access-rules-for-a-user-delete-an-ip-access-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rule_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_single_id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_single_id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - IP Access rules for a user
      summary: Update an IP Access rule
      description: Updates an IP Access rule defined at the user level. You can only
        update the rule action (`mode` parameter) and notes.
      operationId: ip-access-rules-for-a-user-update-an-ip-access-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rule_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                mode:
                  $ref: '#/components/schemas/schemas-mode'
                notes:
                  $ref: '#/components/schemas/notes'
      responses:
        4xx:
          description: Update an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/invites:
    get:
      tags:
      - User's Invites
      summary: List Invitations
      description: Lists all invitations associated with my user.
      operationId: user'-s-invites-list-invitations
      responses:
        4xx:
          description: List Invitations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-collection_invite_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Invitations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-collection_invite_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/invites/{identifier}:
    get:
      tags:
      - User's Invites
      summary: Invitation Details
      description: Gets the details of an invitation.
      operationId: user'-s-invites-invitation-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/invite_components-schemas-identifier'
      responses:
        4xx:
          description: Invitation Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_invite_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Invitation Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_invite_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - User's Invites
      summary: Respond to Invitation
      description: Responds to an invitation.
      operationId: user'-s-invites-respond-to-invitation
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/invite_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - status
              properties:
                status:
                  description: Status of your response to the invitation (rejected
                    or accepted).
                  enum:
                  - accepted
                  - rejected
                  example: accepted
      responses:
        4xx:
          description: Respond to Invitation response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_invite_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Respond to Invitation response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_invite_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/load_balancers/monitors:
    get:
      tags:
      - Load Balancer Monitors
      summary: List Monitors
      description: List configured monitors for a user.
      operationId: load-balancer-monitors-list-monitors
      responses:
        4xx:
          description: List Monitors response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/monitor_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Monitors response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/monitor_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Load Balancer Monitors
      summary: Create Monitor
      description: Create a configured monitor.
      operationId: load-balancer-monitors-create-monitor
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - expected_codes
              properties:
                allow_insecure:
                  $ref: '#/components/schemas/allow_insecure'
                description:
                  $ref: '#/components/schemas/monitor_components-schemas-description'
                expected_body:
                  $ref: '#/components/schemas/expected_body'
                expected_codes:
                  $ref: '#/components/schemas/expected_codes'
                follow_redirects:
                  $ref: '#/components/schemas/follow_redirects'
                header:
                  $ref: '#/components/schemas/header'
                interval:
                  $ref: '#/components/schemas/interval'
                method:
                  $ref: '#/components/schemas/schemas-method'
                path:
                  $ref: '#/components/schemas/path'
                port:
                  $ref: '#/components/schemas/components-schemas-port'
                probe_zone:
                  $ref: '#/components/schemas/probe_zone'
                retries:
                  $ref: '#/components/schemas/retries'
                timeout:
                  $ref: '#/components/schemas/schemas-timeout'
                type:
                  $ref: '#/components/schemas/monitor_components-schemas-type'
      responses:
        4xx:
          description: Create Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/monitor_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/monitor_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/load_balancers/monitors/{identifier}:
    delete:
      tags:
      - Load Balancer Monitors
      summary: Delete Monitor
      description: Delete a configured monitor.
      operationId: load-balancer-monitors-delete-monitor
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/monitor_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/monitor_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Load Balancer Monitors
      summary: Monitor Details
      description: List a single configured monitor for a user.
      operationId: load-balancer-monitors-monitor-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
      responses:
        4xx:
          description: Monitor Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/monitor_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Monitor Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/monitor_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Load Balancer Monitors
      summary: Patch Monitor
      description: Apply changes to an existing monitor, overwriting the supplied
        properties.
      operationId: load-balancer-monitors-patch-monitor
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                allow_insecure:
                  $ref: '#/components/schemas/allow_insecure'
                description:
                  $ref: '#/components/schemas/monitor_components-schemas-description'
                expected_body:
                  $ref: '#/components/schemas/expected_body'
                expected_codes:
                  $ref: '#/components/schemas/expected_codes'
                follow_redirects:
                  $ref: '#/components/schemas/follow_redirects'
                header:
                  $ref: '#/components/schemas/header'
                interval:
                  $ref: '#/components/schemas/interval'
                method:
                  $ref: '#/components/schemas/schemas-method'
                path:
                  $ref: '#/components/schemas/path'
                port:
                  $ref: '#/components/schemas/components-schemas-port'
                probe_zone:
                  $ref: '#/components/schemas/probe_zone'
                retries:
                  $ref: '#/components/schemas/retries'
                timeout:
                  $ref: '#/components/schemas/schemas-timeout'
                type:
                  $ref: '#/components/schemas/monitor_components-schemas-type'
      responses:
        4xx:
          description: Patch Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/monitor_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/monitor_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Load Balancer Monitors
      summary: Update Monitor
      description: Modify a configured monitor.
      operationId: load-balancer-monitors-update-monitor
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - expected_codes
              properties:
                allow_insecure:
                  $ref: '#/components/schemas/allow_insecure'
                description:
                  $ref: '#/components/schemas/monitor_components-schemas-description'
                expected_body:
                  $ref: '#/components/schemas/expected_body'
                expected_codes:
                  $ref: '#/components/schemas/expected_codes'
                follow_redirects:
                  $ref: '#/components/schemas/follow_redirects'
                header:
                  $ref: '#/components/schemas/header'
                interval:
                  $ref: '#/components/schemas/interval'
                method:
                  $ref: '#/components/schemas/schemas-method'
                path:
                  $ref: '#/components/schemas/path'
                port:
                  $ref: '#/components/schemas/components-schemas-port'
                probe_zone:
                  $ref: '#/components/schemas/probe_zone'
                retries:
                  $ref: '#/components/schemas/retries'
                timeout:
                  $ref: '#/components/schemas/schemas-timeout'
                type:
                  $ref: '#/components/schemas/monitor_components-schemas-type'
      responses:
        4xx:
          description: Update Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/monitor_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/monitor_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/load_balancers/monitors/{identifier}/preview:
    post:
      tags:
      - Load Balancer Monitors
      summary: Preview Monitor
      description: Preview pools using the specified monitor with provided monitor
        details. The returned preview_id can be used in the preview endpoint to retrieve
        the results.
      operationId: load-balancer-monitors-preview-monitor
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - expected_codes
              properties:
                allow_insecure:
                  $ref: '#/components/schemas/allow_insecure'
                expected_body:
                  $ref: '#/components/schemas/expected_body'
                expected_codes:
                  $ref: '#/components/schemas/expected_codes'
                follow_redirects:
                  $ref: '#/components/schemas/follow_redirects'
                header:
                  $ref: '#/components/schemas/header'
                method:
                  $ref: '#/components/schemas/schemas-method'
                path:
                  $ref: '#/components/schemas/path'
                port:
                  $ref: '#/components/schemas/components-schemas-port'
                retries:
                  $ref: '#/components/schemas/retries'
                timeout:
                  $ref: '#/components/schemas/schemas-timeout'
                type:
                  $ref: '#/components/schemas/monitor_components-schemas-type'
      responses:
        4xx:
          description: Preview Monitor response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/preview_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Preview Monitor response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/preview_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/load_balancers/monitors/{identifier}/references:
    get:
      tags:
      - Load Balancer Monitors
      summary: List Monitor References
      description: Get the list of resources that reference the provided monitor.
      operationId: load-balancer-monitors-list-monitor-references
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/monitor_components-schemas-identifier'
      responses:
        4xx:
          description: List Monitor References response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/references_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Monitor References response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/references_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/load_balancers/pools:
    get:
      tags:
      - Load Balancer Pools
      summary: List Pools
      description: List configured pools.
      operationId: load-balancer-pools-list-pools
      responses:
        4xx:
          description: List Pools response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Pools response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Load Balancer Pools
      summary: Patch Pools
      description: Apply changes to a number of existing pools, overwriting the supplied
        properties. Pools are ordered by ascending `name`. Returns the list of affected
        pools. Supports the standard pagination query parameters, either `limit`/`offset`
        or `per_page`/`page`.
      operationId: load-balancer-pools-patch-pools
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                notification_email:
                  $ref: '#/components/schemas/patch_pools_notification_email'
      responses:
        4xx:
          description: Patch Pools response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch Pools response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Load Balancer Pools
      summary: Create Pool
      description: Create a new pool.
      operationId: load-balancer-pools-create-pool
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - origins
              - name
              properties:
                check_regions:
                  $ref: '#/components/schemas/check_regions'
                description:
                  $ref: '#/components/schemas/pool_components-schemas-description'
                enabled:
                  $ref: '#/components/schemas/pool_components-schemas-enabled'
                latitude:
                  $ref: '#/components/schemas/latitude'
                load_shedding:
                  $ref: '#/components/schemas/load_shedding'
                longitude:
                  $ref: '#/components/schemas/longitude'
                minimum_origins:
                  $ref: '#/components/schemas/minimum_origins'
                monitor:
                  $ref: '#/components/schemas/schemas-monitor'
                name:
                  $ref: '#/components/schemas/pool_components-schemas-name'
                notification_email:
                  $ref: '#/components/schemas/notification_email'
                notification_filter:
                  $ref: '#/components/schemas/notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/origin_steering'
                origins:
                  $ref: '#/components/schemas/origins'
      responses:
        4xx:
          description: Create Pool response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Pool response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/load_balancers/pools/{identifier}:
    delete:
      tags:
      - Load Balancer Pools
      summary: Delete Pool
      description: Delete a configured pool.
      operationId: load-balancer-pools-delete-pool
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Pool response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Pool response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Load Balancer Pools
      summary: Pool Details
      description: Fetch a single configured pool.
      operationId: load-balancer-pools-pool-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      responses:
        4xx:
          description: Pool Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Pool Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Load Balancer Pools
      summary: Patch Pool
      description: Apply changes to an existing pool, overwriting the supplied properties.
      operationId: load-balancer-pools-patch-pool
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                check_regions:
                  $ref: '#/components/schemas/check_regions'
                description:
                  $ref: '#/components/schemas/pool_components-schemas-description'
                disabled_at:
                  $ref: '#/components/schemas/schemas-disabled_at'
                enabled:
                  $ref: '#/components/schemas/pool_components-schemas-enabled'
                latitude:
                  $ref: '#/components/schemas/latitude'
                load_shedding:
                  $ref: '#/components/schemas/load_shedding'
                longitude:
                  $ref: '#/components/schemas/longitude'
                minimum_origins:
                  $ref: '#/components/schemas/minimum_origins'
                monitor:
                  $ref: '#/components/schemas/schemas-monitor'
                name:
                  $ref: '#/components/schemas/pool_components-schemas-name'
                notification_email:
                  $ref: '#/components/schemas/notification_email'
                notification_filter:
                  $ref: '#/components/schemas/notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/origin_steering'
                origins:
                  $ref: '#/components/schemas/origins'
      responses:
        4xx:
          description: Patch Pool response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch Pool response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Load Balancer Pools
      summary: Update Pool
      description: Modify a configured pool.
      operationId: load-balancer-pools-update-pool
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - origins
              - name
              properties:
                check_regions:
                  $ref: '#/components/schemas/check_regions'
                description:
                  $ref: '#/components/schemas/pool_components-schemas-description'
                disabled_at:
                  $ref: '#/components/schemas/schemas-disabled_at'
                enabled:
                  $ref: '#/components/schemas/pool_components-schemas-enabled'
                latitude:
                  $ref: '#/components/schemas/latitude'
                load_shedding:
                  $ref: '#/components/schemas/load_shedding'
                longitude:
                  $ref: '#/components/schemas/longitude'
                minimum_origins:
                  $ref: '#/components/schemas/minimum_origins'
                monitor:
                  $ref: '#/components/schemas/schemas-monitor'
                name:
                  $ref: '#/components/schemas/pool_components-schemas-name'
                notification_email:
                  $ref: '#/components/schemas/notification_email'
                notification_filter:
                  $ref: '#/components/schemas/notification_filter'
                origin_steering:
                  $ref: '#/components/schemas/origin_steering'
                origins:
                  $ref: '#/components/schemas/origins'
      responses:
        4xx:
          description: Update Pool response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pool_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Pool response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pool_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/load_balancers/pools/{identifier}/health:
    get:
      tags:
      - Load Balancer Pools
      summary: Pool Health Details
      description: Fetch the latest pool health status for a single pool.
      operationId: load-balancer-pools-pool-health-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      responses:
        4xx:
          description: Pool Health Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/health_details'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Pool Health Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/health_details'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/load_balancers/pools/{identifier}/preview:
    post:
      tags:
      - Load Balancer Pools
      summary: Preview Pool
      description: Preview pool health using provided monitor details. The returned
        preview_id can be used in the preview endpoint to retrieve the results.
      operationId: load-balancer-pools-preview-pool
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - expected_codes
              properties:
                allow_insecure:
                  $ref: '#/components/schemas/allow_insecure'
                expected_body:
                  $ref: '#/components/schemas/expected_body'
                expected_codes:
                  $ref: '#/components/schemas/expected_codes'
                follow_redirects:
                  $ref: '#/components/schemas/follow_redirects'
                header:
                  $ref: '#/components/schemas/header'
                method:
                  $ref: '#/components/schemas/schemas-method'
                path:
                  $ref: '#/components/schemas/path'
                port:
                  $ref: '#/components/schemas/components-schemas-port'
                retries:
                  $ref: '#/components/schemas/retries'
                timeout:
                  $ref: '#/components/schemas/schemas-timeout'
                type:
                  $ref: '#/components/schemas/monitor_components-schemas-type'
      responses:
        4xx:
          description: Preview Pool response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/preview_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Preview Pool response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/preview_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/load_balancers/pools/{identifier}/references:
    get:
      tags:
      - Load Balancer Pools
      summary: List Pool References
      description: Get the list of resources that reference the provided pool.
      operationId: load-balancer-pools-list-pool-references
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/pool_components-schemas-identifier'
      responses:
        4xx:
          description: List Pool References response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-references_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Pool References response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-references_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/load_balancers/preview/{preview_id}:
    get:
      tags:
      - Load Balancer Monitors
      summary: Preview Result
      description: Get the result of a previous preview operation using the provided
        preview_id.
      operationId: load-balancer-monitors-preview-result
      parameters:
      - name: preview_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/preview_id'
      responses:
        4xx:
          description: Preview Result response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/preview_result_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Preview Result response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/preview_result_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/load_balancing_analytics/events:
    get:
      tags:
      - Load Balancer Healthcheck Events
      summary: List Healthcheck Events
      description: List origin health changes.
      operationId: load-balancer-healthcheck-events-list-healthcheck-events
      responses:
        4xx:
          description: List Healthcheck Events response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/analytics_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Healthcheck Events response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/organizations:
    get:
      tags:
      - User's Organizations
      summary: List Organizations
      description: Lists organizations the user is associated with.
      operationId: user'-s-organizations-list-organizations
      responses:
        4xx:
          description: List Organizations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/collection_organization_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Organizations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collection_organization_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/organizations/{identifier}:
    delete:
      tags:
      - User's Organizations
      summary: Leave Organization
      description: Removes association to an organization.
      operationId: user'-s-organizations-leave-organization
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Leave Organization response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    id:
                      $ref: '#/components/schemas/common_components-schemas-identifier'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Leave Organization response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    $ref: '#/components/schemas/common_components-schemas-identifier'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - User's Organizations
      summary: Organization Details
      description: Gets a specific organization the user is associated with.
      operationId: user'-s-organizations-organization-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Organization Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_organization_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Organization Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_organization_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/subscriptions:
    get:
      tags:
      - User Subscription
      summary: Get User Subscriptions
      description: Lists all of a user's subscriptions.
      operationId: user-subscription-get-user-subscriptions
      responses:
        4xx:
          description: Get User Subscriptions response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_subscription_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get User Subscriptions response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/user_subscription_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/subscriptions/{identifier}:
    delete:
      tags:
      - User Subscription
      summary: Delete User Subscription
      description: Deletes a user's subscription.
      operationId: user-subscription-delete-user-subscription
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/subscription-v2_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete User Subscription response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    subscription_id:
                      $ref: '#/components/schemas/subscription-v2_components-schemas-identifier'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete User Subscription response
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscription_id:
                    $ref: '#/components/schemas/subscription-v2_components-schemas-identifier'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - User Subscription
      summary: Update User Subscription
      description: Updates a user's subscriptions.
      operationId: user-subscription-update-user-subscription
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/subscription-v2_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscription-v2'
      responses:
        4xx:
          description: Update User Subscription response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/user_subscription_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update User Subscription response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/user_subscription_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /user/tokens:
    get:
      tags:
      - User API Tokens
      summary: List Tokens
      description: List all access tokens you created.
      operationId: user-api-tokens-list-tokens
      responses:
        4xx:
          description: List Tokens response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Tokens response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_collection'
      security:
      - api_token: []
    post:
      tags:
      - User API Tokens
      summary: Create Token
      description: Create a new access token.
      operationId: user-api-tokens-create-token
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_payload'
      responses:
        4xx:
          description: Create Token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_create'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_create'
      security:
      - api_token: []
  /user/tokens/{identifier}:
    delete:
      tags:
      - User API Tokens
      summary: Delete Token
      description: Destroy a token.
      operationId: user-api-tokens-delete-token
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      security:
      - api_token: []
    get:
      tags:
      - User API Tokens
      summary: Token Details
      description: Get information about a specific token.
      operationId: user-api-tokens-token-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      responses:
        4xx:
          description: Token Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Token Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single'
      security:
      - api_token: []
    put:
      tags:
      - User API Tokens
      summary: Update Token
      description: Update an existing token.
      operationId: user-api-tokens-update-token
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas-token'
      responses:
        4xx:
          description: Update Token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single'
      security:
      - api_token: []
  /user/tokens/{identifier}/value:
    put:
      tags:
      - User API Tokens
      summary: Roll Token
      description: Roll the token secret.
      operationId: user-api-tokens-roll-token
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
      responses:
        4xx:
          description: Roll Token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single_value'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Roll Token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single_value'
      security:
      - api_token: []
  /user/tokens/permission_groups:
    get:
      tags:
      - Permission Groups
      summary: List Permission Groups
      description: Find all available permission groups.
      operationId: permission-groups-list-permission-groups
      responses:
        4xx:
          description: List Permission Groups response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Permission Groups response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-response_collection'
      security:
      - api_token: []
  /user/tokens/verify:
    get:
      tags:
      - User API Tokens
      summary: Verify Token
      description: Test whether a token works.
      operationId: user-api-tokens-verify-token
      responses:
        4xx:
          description: Verify Token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single_segment'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Verify Token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single_segment'
      security:
      - api_token: []
  /zones:
    get:
      tags:
      - Zone
      summary: List Zones
      description: Lists, searches, sorts, and filters your zones.
      operationId: zone-list-zones
      responses:
        4xx:
          description: List Zones response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Zones response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone
      summary: Create Zone
      operationId: zone-create-zone
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas-create'
      responses:
        4xx:
          description: Create Zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}:
    delete:
      tags:
      - Zone
      summary: Delete Zone
      description: Deletes an existing zone.
      operationId: zone-delete-zone
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zone
      summary: Zone Details
      operationId: zone-zone-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      responses:
        4xx:
          description: Zone Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Zone Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone
      summary: Edit Zone
      description: Editz a zone. Only one zone property can be changed at a time.
      operationId: zone-edit-zone
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas-patch'
      responses:
        4xx:
          description: Edit Zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit Zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/apps:
    get:
      tags:
      - Zone-Level Access applications
      summary: 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/apps_components-schemas-identifier'
      responses:
        4xx:
          description: List Access Applications response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apps_components-schemas-response_collection-2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Access Applications response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apps_components-schemas-response_collection-2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone-Level Access applications
      summary: Add a Bookmark application
      description: Adds a custom link to the App Launcher. Bookmark applications are
        not protected by Access.
      operationId: zone-level-access-applications-add-a-bookmark-application
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              - domain
      responses:
        4xx:
          description: Add a Bookmark application response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/apps_components-schemas-single_response-2'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/basic_app_response_props'
                        - $ref: '#/components/schemas/schemas-bookmark_props'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add a Bookmark application response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apps_components-schemas-single_response-2'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/basic_app_response_props'
                      - $ref: '#/components/schemas/schemas-bookmark_props'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/apps/{app_id}:
    delete:
      tags:
      - Zone-Level Access applications
      summary: 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/schemas-app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an Access application response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apps_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an Access application response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apps_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zone-Level Access applications
      summary: 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/schemas-app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      responses:
        4xx:
          description: Get an Access application response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apps_components-schemas-single_response-2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an Access application response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/apps_components-schemas-single_response-2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zone-Level Access applications
      summary: Update a Bookmark application
      description: Updates a Bookmark application.
      operationId: zone-level-access-applications-update-a-bookmark-application
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              - domain
      responses:
        4xx:
          description: Update a Bookmark application response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/apps_components-schemas-single_response-2'
                  - properties:
                      result:
                        allOf:
                        - $ref: '#/components/schemas/basic_app_response_props'
                        - $ref: '#/components/schemas/schemas-bookmark_props'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a Bookmark application response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/apps_components-schemas-single_response-2'
                - properties:
                    result:
                      allOf:
                      - $ref: '#/components/schemas/basic_app_response_props'
                      - $ref: '#/components/schemas/schemas-bookmark_props'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/apps/{app_id}/revoke_tokens:
    post:
      tags:
      - Zone-Level Access applications
      summary: Revoke service tokens
      description: Revokes all service tokens used by an application.
      operationId: zone-level-access-applications-revoke-service-tokens
      parameters:
      - name: app_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Revoke service tokens response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-empty_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Revoke service tokens response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-empty_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/apps/{app_id}/user_policy_checks:
    get:
      tags:
      - Zone-Level Access applications
      summary: 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/schemas-app_id'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/apps_components-schemas-identifier'
      responses:
        4xx:
          description: Test Access policies response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policy_check_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Test Access policies response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policy_check_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/apps/{uuid}/ca:
    delete:
      tags:
      - Zone-Level Access short-lived certificate CAs
      summary: 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/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a short-lived certificate CA response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ca_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a short-lived certificate CA response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ca_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zone-Level Access short-lived certificate CAs
      summary: 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/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a short-lived certificate CA response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ca_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a short-lived certificate CA response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ca_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone-Level Access short-lived certificate CAs
      summary: 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/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Create a short-lived certificate CA response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ca_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a short-lived certificate CA response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ca_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/apps/{uuid}/policies:
    get:
      tags:
      - Zone-Level Access policies
      summary: 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/components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/policies_components-schemas-identifier'
      responses:
        4xx:
          description: List Access policies response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Access policies response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone-Level Access policies
      summary: 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/components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/policies_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - decision
              - include
              properties:
                approval_groups:
                  $ref: '#/components/schemas/approval_groups'
                approval_required:
                  $ref: '#/components/schemas/approval_required'
                decision:
                  $ref: '#/components/schemas/decision'
                exclude:
                  $ref: '#/components/schemas/schemas-exclude'
                include:
                  $ref: '#/components/schemas/include'
                name:
                  $ref: '#/components/schemas/policies_components-schemas-name'
                precedence:
                  $ref: '#/components/schemas/precedence'
                purpose_justification_prompt:
                  $ref: '#/components/schemas/purpose_justification_prompt'
                purpose_justification_required:
                  $ref: '#/components/schemas/purpose_justification_required'
                require:
                  $ref: '#/components/schemas/schemas-require'
      responses:
        4xx:
          description: Create an Access policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create an Access policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/apps/{uuid1}/policies/{uuid}:
    delete:
      tags:
      - Zone-Level Access policies
      summary: 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/components-schemas-uuid'
      - name: uuid1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/policies_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an Access policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an Access policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zone-Level Access policies
      summary: 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/components-schemas-uuid'
      - name: uuid1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/policies_components-schemas-identifier'
      responses:
        4xx:
          description: Get an Access policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an Access policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zone-Level Access policies
      summary: 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/components-schemas-uuid'
      - name: uuid1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/components-schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/policies_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - decision
              - include
              properties:
                approval_groups:
                  $ref: '#/components/schemas/approval_groups'
                approval_required:
                  $ref: '#/components/schemas/approval_required'
                decision:
                  $ref: '#/components/schemas/decision'
                exclude:
                  $ref: '#/components/schemas/schemas-exclude'
                include:
                  $ref: '#/components/schemas/include'
                name:
                  $ref: '#/components/schemas/policies_components-schemas-name'
                precedence:
                  $ref: '#/components/schemas/precedence'
                purpose_justification_prompt:
                  $ref: '#/components/schemas/purpose_justification_prompt'
                purpose_justification_required:
                  $ref: '#/components/schemas/purpose_justification_required'
                require:
                  $ref: '#/components/schemas/schemas-require'
      responses:
        4xx:
          description: Update an Access policy response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/policies_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an Access policy response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/policies_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/apps/ca:
    get:
      tags:
      - Zone-Level Access short-lived certificate CAs
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List short-lived certificate CAs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ca_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List short-lived certificate CAs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ca_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/certificates:
    get:
      tags:
      - Zone-Level Access mTLS authentication
      summary: List mTLS certificates
      description: Lists all mTLS certificates.
      operationId: zone-level-access-m-tls-authentication-list-m-tls-certificates
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List mTLS certificates response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificates_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List mTLS certificates response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificates_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone-Level Access mTLS authentication
      summary: Add an mTLS certificate
      description: Adds a new mTLS root certificate to Access.
      operationId: zone-level-access-m-tls-authentication-add-an-m-tls-certificate
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - certificate
              properties:
                associated_hostnames:
                  $ref: '#/components/schemas/associated_hostnames'
                certificate:
                  type: string
                  description: The certificate content.
                  example: |-
                    -----BEGIN CERTIFICATE-----
                    MIIGAjCCA+qgAwIBAgIJAI7kymlF7CWT...N4RI7KKB7nikiuUf8vhULKy5IX10
                    DrUtmu/B
                    -----END CERTIFICATE-----
                name:
                  $ref: '#/components/schemas/certificates_components-schemas-name'
      responses:
        4xx:
          description: Add an mTLS certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificates_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add an mTLS certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificates_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/certificates/{uuid}:
    delete:
      tags:
      - Zone-Level Access mTLS authentication
      summary: Delete an mTLS certificate
      description: Deletes an mTLS certificate.
      operationId: zone-level-access-m-tls-authentication-delete-an-m-tls-certificate
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an mTLS certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificates_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an mTLS certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificates_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zone-Level Access mTLS authentication
      summary: Get an mTLS certificate
      description: Fetches a single mTLS certificate.
      operationId: zone-level-access-m-tls-authentication-get-an-m-tls-certificate
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get an mTLS certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificates_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an mTLS certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificates_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zone-Level Access mTLS authentication
      summary: Update an mTLS certificate
      description: Updates a configured mTLS certificate.
      operationId: zone-level-access-m-tls-authentication-update-an-m-tls-certificate
      parameters:
      - name: uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - associated_hostnames
              properties:
                associated_hostnames:
                  $ref: '#/components/schemas/associated_hostnames'
                name:
                  $ref: '#/components/schemas/certificates_components-schemas-name'
      responses:
        4xx:
          description: Update an mTLS certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificates_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an mTLS certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificates_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/groups:
    get:
      tags:
      - Zone-Level Access groups
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Access groups response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/groups_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Access groups response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/groups_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone-Level Access groups
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - include
              properties:
                exclude:
                  $ref: '#/components/schemas/exclude'
                include:
                  $ref: '#/components/schemas/include'
                name:
                  $ref: '#/components/schemas/groups_components-schemas-name'
                require:
                  $ref: '#/components/schemas/require'
      responses:
        4xx:
          description: Create an Access group response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/groups_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create an Access group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/groups_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/groups/{uuid}:
    delete:
      tags:
      - Zone-Level Access groups
      summary: 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/schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an Access group response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/groups_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an Access group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/groups_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zone-Level Access groups
      summary: 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/schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get an Access group response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/groups_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an Access group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/groups_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zone-Level Access groups
      summary: 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/schemas-uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - include
              properties:
                exclude:
                  $ref: '#/components/schemas/exclude'
                include:
                  $ref: '#/components/schemas/include'
                name:
                  $ref: '#/components/schemas/groups_components-schemas-name'
                require:
                  $ref: '#/components/schemas/require'
      responses:
        4xx:
          description: Update an Access group response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/groups_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an Access group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/groups_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/identity_providers:
    get:
      tags:
      - Zone-Level Access identity providers
      summary: 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/identity-providers_components-schemas-identifier'
      responses:
        4xx:
          description: List Access identity providers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/identity-providers_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Access identity providers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity-providers_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone-Level Access identity providers
      summary: 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/identity-providers_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              - config
              properties:
                config:
                  $ref: '#/components/schemas/schemas-config'
                name:
                  $ref: '#/components/schemas/identity-providers_components-schemas-name'
                type:
                  $ref: '#/components/schemas/identity-providers_components-schemas-type'
      responses:
        4xx:
          description: Add an Access identity provider response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add an Access identity provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/identity_providers/{uuid}:
    delete:
      tags:
      - Zone-Level Access identity providers
      summary: 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/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identity-providers_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an Access identity provider response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an Access identity provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zone-Level Access identity providers
      summary: 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/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identity-providers_components-schemas-identifier'
      responses:
        4xx:
          description: Get an Access identity provider response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get an Access identity provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zone-Level Access identity providers
      summary: 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/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/identity-providers_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - type
              - config
              properties:
                config:
                  $ref: '#/components/schemas/schemas-config'
                name:
                  $ref: '#/components/schemas/identity-providers_components-schemas-name'
                type:
                  $ref: '#/components/schemas/identity-providers_components-schemas-type'
      responses:
        4xx:
          description: Update an Access identity provider response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an Access identity provider response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/identity-providers_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/organizations:
    get:
      tags:
      - Zone-Level Zero Trust organization
      summary: 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/organizations_components-schemas-identifier'
      responses:
        4xx:
          description: Get your Zero Trust organization response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/organizations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get your Zero Trust organization response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone-Level Zero Trust organization
      summary: 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/organizations_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - auth_domain
              properties:
                auth_domain:
                  $ref: '#/components/schemas/auth_domain'
                is_ui_read_only:
                  $ref: '#/components/schemas/is_ui_read_only'
                login_design:
                  $ref: '#/components/schemas/login_design'
                name:
                  $ref: '#/components/schemas/organizations_components-schemas-name'
      responses:
        4xx:
          description: Create your Zero Trust organization response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/organizations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create your Zero Trust organization response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zone-Level Zero Trust organization
      summary: 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/organizations_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                auth_domain:
                  $ref: '#/components/schemas/auth_domain'
                is_ui_read_only:
                  $ref: '#/components/schemas/is_ui_read_only'
                login_design:
                  $ref: '#/components/schemas/login_design'
                name:
                  $ref: '#/components/schemas/organizations_components-schemas-name'
      responses:
        4xx:
          description: Update your Zero Trust organization response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/organizations_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update your Zero Trust organization response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/organizations_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/organizations/revoke_user:
    post:
      tags:
      - Zone-Level Zero Trust organization
      summary: 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/organizations_components-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:
        4xx:
          description: Revoke all Access tokens for a user response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-empty_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Revoke all Access tokens for a user response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-empty_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/service_tokens:
    get:
      tags:
      - Zone-Level Access service tokens
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List service tokens response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service-tokens_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List service tokens response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service-tokens_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone-Level Access service tokens
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              properties:
                name:
                  $ref: '#/components/schemas/service-tokens_components-schemas-name'
      responses:
        4xx:
          description: Create a service token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/create_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a service token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/create_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/access/service_tokens/{uuid}:
    delete:
      tags:
      - Zone-Level Access service tokens
      summary: 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/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a service token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service-tokens_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a service token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service-tokens_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zone-Level Access service tokens
      summary: 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/uuid'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                name:
                  $ref: '#/components/schemas/service-tokens_components-schemas-name'
      responses:
        4xx:
          description: Update a service token response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/service-tokens_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a service token response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/service-tokens_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/activation_check:
    put:
      tags:
      - Zone
      summary: Zone Activation Check
      description: Initiates another zone activation check.
      operationId: zone-zone-activation-check
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Zone Activation Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Zone Activation Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/dns_analytics/report:
    get:
      tags:
      - DNS Analytics
      summary: Table
      description: Retrieves a list of summarised aggregate metrics over a given time
        period.
      operationId: dns-analytics-table
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Table response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - type: object
                    properties:
                      result:
                        $ref: '#/components/schemas/result'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Table response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/result'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/dns_analytics/report/bytime:
    get:
      tags:
      - DNS Analytics
      summary: By Time
      description: Retrieves a list of aggregate metrics grouped by time interval.
      operationId: dns-analytics-by-time
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: By Time response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - type: object
                    properties:
                      result:
                        $ref: '#/components/schemas/result'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: By Time response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - type: object
                  properties:
                    result:
                      $ref: '#/components/schemas/result'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/load_balancers:
    get:
      tags:
      - Load Balancers
      summary: List Load Balancers
      description: List configured load balancers.
      operationId: load-balancers-list-load-balancers
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancer_components-schemas-identifier'
      responses:
        4xx:
          description: List Load Balancers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancer_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Load Balancers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancer_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Load Balancers
      summary: Create Load Balancer
      description: Create a new load balancer.
      operationId: load-balancers-create-load-balancer
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancer_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - default_pools
              - fallback_pool
              properties:
                adaptive_routing:
                  $ref: '#/components/schemas/adaptive_routing'
                country_pools:
                  $ref: '#/components/schemas/country_pools'
                default_pools:
                  $ref: '#/components/schemas/default_pools'
                description:
                  $ref: '#/components/schemas/load-balancer_components-schemas-description'
                fallback_pool:
                  $ref: '#/components/schemas/fallback_pool'
                location_strategy:
                  $ref: '#/components/schemas/location_strategy'
                name:
                  $ref: '#/components/schemas/load-balancer_components-schemas-name'
                pop_pools:
                  $ref: '#/components/schemas/pop_pools'
                proxied:
                  $ref: '#/components/schemas/schemas-proxied'
                random_steering:
                  $ref: '#/components/schemas/random_steering'
                region_pools:
                  $ref: '#/components/schemas/region_pools'
                rules:
                  $ref: '#/components/schemas/load-balancer_components-schemas-rules'
                session_affinity:
                  $ref: '#/components/schemas/session_affinity'
                session_affinity_attributes:
                  $ref: '#/components/schemas/session_affinity_attributes'
                session_affinity_ttl:
                  $ref: '#/components/schemas/session_affinity_ttl'
                steering_policy:
                  $ref: '#/components/schemas/steering_policy'
                ttl:
                  $ref: '#/components/schemas/schemas-ttl'
      responses:
        4xx:
          description: Create Load Balancer response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancer_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Load Balancer response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancer_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/purge_cache:
    post:
      tags:
      - Zone
      summary: Purge Files by Cache-Tags, Host, or Prefix
      description: |-
        Granularly removes one or more files from Cloudflare's cache either by specifying the host, the associated Cache-Tag, or a 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-files-by-cache-tags,-host,-or-prefix
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/purge_by_cache_tags_or_hosts_or_prefixes'
      responses:
        4xx:
          description: Purge Files by Cache-Tags, Host, or Prefix response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Purge Files by Cache-Tags, Host, or Prefix response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/secondary_dns/force_axfr:
    post:
      tags:
      - Secondary DNS (Secondary Zone)
      summary: Force AXFR
      description: Sends AXFR zone transfer request to primary nameserver(s).
      operationId: secondary-dns-(-secondary-zone)-force-axfr
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Force AXFR response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/force_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Force AXFR response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/force_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/secondary_dns/incoming:
    delete:
      tags:
      - Secondary DNS (Secondary Zone)
      summary: Delete Secondary Zone Configuration
      description: Delete secondary zone configuration for incoming zone transfers.
      operationId: secondary-dns-(-secondary-zone)-delete-secondary-zone-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Secondary Zone Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Secondary Zone Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Secondary DNS (Secondary Zone)
      summary: Secondary Zone Configuration Details
      description: Get secondary zone configuration for incoming zone transfers.
      operationId: secondary-dns-(-secondary-zone)-secondary-zone-configuration-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier'
      responses:
        4xx:
          description: Secondary Zone Configuration Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_response_incoming'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Secondary Zone Configuration Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_response_incoming'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Secondary DNS (Secondary Zone)
      summary: Create Secondary Zone Configuration
      description: Create secondary zone configuration for incoming zone transfers.
      operationId: secondary-dns-(-secondary-zone)-create-secondary-zone-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-secondary-secondary-zone'
      responses:
        4xx:
          description: Create Secondary Zone Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_response_incoming'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Secondary Zone Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_response_incoming'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Secondary DNS (Secondary Zone)
      summary: Update Secondary Zone Configuration
      description: Update secondary zone configuration for incoming zone transfers.
      operationId: secondary-dns-(-secondary-zone)-update-secondary-zone-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-secondary-zone_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/dns-secondary-secondary-zone'
      responses:
        4xx:
          description: Update Secondary Zone Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_response_incoming'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Secondary Zone Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_response_incoming'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/secondary_dns/outgoing:
    delete:
      tags:
      - Secondary DNS (Primary Zone)
      summary: Delete Primary Zone Configuration
      description: Delete primary zone configuration for outgoing zone transfers.
      operationId: secondary-dns-(-primary-zone)-delete-primary-zone-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Primary Zone Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Primary Zone Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Secondary DNS (Primary Zone)
      summary: Primary Zone Configuration Details
      description: Get primary zone configuration for outgoing zone transfers.
      operationId: secondary-dns-(-primary-zone)-primary-zone-configuration-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier'
      responses:
        4xx:
          description: Primary Zone Configuration Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_response_outgoing'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Primary Zone Configuration Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_response_outgoing'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Secondary DNS (Primary Zone)
      summary: Create Primary Zone Configuration
      description: Create primary zone configuration for outgoing zone transfers.
      operationId: secondary-dns-(-primary-zone)-create-primary-zone-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/single_request_outgoing'
      responses:
        4xx:
          description: Create Primary Zone Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_response_outgoing'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Primary Zone Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_response_outgoing'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Secondary DNS (Primary Zone)
      summary: Update Primary Zone Configuration
      description: Update primary zone configuration for outgoing zone transfers.
      operationId: secondary-dns-(-primary-zone)-update-primary-zone-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/single_request_outgoing'
      responses:
        4xx:
          description: Update Primary Zone Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_response_outgoing'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Primary Zone Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_response_outgoing'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/secondary_dns/outgoing/disable:
    post:
      tags:
      - Secondary DNS (Primary Zone)
      summary: 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: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Disable Outgoing Zone Transfers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/disable_transfer_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Disable Outgoing Zone Transfers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/disable_transfer_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/secondary_dns/outgoing/enable:
    post:
      tags:
      - Secondary DNS (Primary Zone)
      summary: Enable Outgoing Zone Transfers
      description: Enable outgoing zone transfers for primary zone.
      operationId: secondary-dns-(-primary-zone)-enable-outgoing-zone-transfers
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Enable Outgoing Zone Transfers response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/enable_transfer_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Enable Outgoing Zone Transfers response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enable_transfer_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/secondary_dns/outgoing/force_notify:
    post:
      tags:
      - Secondary DNS (Primary Zone)
      summary: 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: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Force DNS NOTIFY response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-force_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Force DNS NOTIFY response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-force_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/secondary_dns/outgoing/status:
    get:
      tags:
      - Secondary DNS (Primary Zone)
      summary: Get Outgoing Zone Transfer Status
      description: Get primary zone transfer status.
      operationId: secondary-dns-(-primary-zone)-get-outgoing-zone-transfer-status
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-secondary-primary-zone_components-schemas-identifier'
      responses:
        4xx:
          description: Get Outgoing Zone Transfer Status response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/enable_transfer_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Outgoing Zone Transfer Status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enable_transfer_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/ssl/analyze:
    post:
      tags:
      - Analyze Certificate
      summary: 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: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                bundle_method:
                  $ref: '#/components/schemas/bundle_method'
                certificate:
                  $ref: '#/components/schemas/certificate'
      responses:
        4xx:
          description: Analyze Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_analyze_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Analyze Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_analyze_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier}/subscription:
    get:
      tags:
      - Zone Subscription
      summary: 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/subscription-v2_components-schemas-identifier'
      responses:
        4xx:
          description: Zone Subscription Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_subscription_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Zone Subscription Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zone_subscription_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone Subscription
      summary: 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/subscription-v2_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscription-v2'
      responses:
        4xx:
          description: Create Zone Subscription response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_subscription_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Zone Subscription response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zone_subscription_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zone Subscription
      summary: 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/subscription-v2_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/subscription-v2'
      responses:
        4xx:
          description: Update Zone Subscription response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_subscription_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Zone Subscription response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zone_subscription_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{identifier1}/load_balancers/{identifier}:
    delete:
      tags:
      - Load Balancers
      summary: Delete Load Balancer
      description: Delete a configured load balancer.
      operationId: load-balancers-delete-load-balancer
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancer_components-schemas-identifier'
      - name: identifier1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancer_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Load Balancer response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancer_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Load Balancer response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancer_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Load Balancers
      summary: Load Balancer Details
      description: Fetch a single configured load balancer.
      operationId: load-balancers-load-balancer-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancer_components-schemas-identifier'
      - name: identifier1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancer_components-schemas-identifier'
      responses:
        4xx:
          description: Load Balancer Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancer_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Load Balancer Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancer_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Load Balancers
      summary: Patch Load Balancer
      description: Apply changes to an existing load balancer, overwriting the supplied
        properties.
      operationId: load-balancers-patch-load-balancer
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancer_components-schemas-identifier'
      - name: identifier1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancer_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                adaptive_routing:
                  $ref: '#/components/schemas/adaptive_routing'
                country_pools:
                  $ref: '#/components/schemas/country_pools'
                default_pools:
                  $ref: '#/components/schemas/default_pools'
                description:
                  $ref: '#/components/schemas/load-balancer_components-schemas-description'
                enabled:
                  $ref: '#/components/schemas/load-balancer_components-schemas-enabled'
                fallback_pool:
                  $ref: '#/components/schemas/fallback_pool'
                location_strategy:
                  $ref: '#/components/schemas/location_strategy'
                name:
                  $ref: '#/components/schemas/load-balancer_components-schemas-name'
                pop_pools:
                  $ref: '#/components/schemas/pop_pools'
                proxied:
                  $ref: '#/components/schemas/schemas-proxied'
                random_steering:
                  $ref: '#/components/schemas/random_steering'
                region_pools:
                  $ref: '#/components/schemas/region_pools'
                rules:
                  $ref: '#/components/schemas/load-balancer_components-schemas-rules'
                session_affinity:
                  $ref: '#/components/schemas/session_affinity'
                session_affinity_attributes:
                  $ref: '#/components/schemas/session_affinity_attributes'
                session_affinity_ttl:
                  $ref: '#/components/schemas/session_affinity_ttl'
                steering_policy:
                  $ref: '#/components/schemas/steering_policy'
                ttl:
                  $ref: '#/components/schemas/schemas-ttl'
      responses:
        4xx:
          description: Patch Load Balancer response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancer_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch Load Balancer response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancer_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Load Balancers
      summary: Update Load Balancer
      description: Update a configured load balancer.
      operationId: load-balancers-update-load-balancer
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancer_components-schemas-identifier'
      - name: identifier1
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/load-balancer_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - name
              - default_pools
              - fallback_pool
              properties:
                adaptive_routing:
                  $ref: '#/components/schemas/adaptive_routing'
                country_pools:
                  $ref: '#/components/schemas/country_pools'
                default_pools:
                  $ref: '#/components/schemas/default_pools'
                description:
                  $ref: '#/components/schemas/load-balancer_components-schemas-description'
                enabled:
                  $ref: '#/components/schemas/load-balancer_components-schemas-enabled'
                fallback_pool:
                  $ref: '#/components/schemas/fallback_pool'
                location_strategy:
                  $ref: '#/components/schemas/location_strategy'
                name:
                  $ref: '#/components/schemas/load-balancer_components-schemas-name'
                pop_pools:
                  $ref: '#/components/schemas/pop_pools'
                proxied:
                  $ref: '#/components/schemas/schemas-proxied'
                random_steering:
                  $ref: '#/components/schemas/random_steering'
                region_pools:
                  $ref: '#/components/schemas/region_pools'
                rules:
                  $ref: '#/components/schemas/load-balancer_components-schemas-rules'
                session_affinity:
                  $ref: '#/components/schemas/session_affinity'
                session_affinity_attributes:
                  $ref: '#/components/schemas/session_affinity_attributes'
                session_affinity_ttl:
                  $ref: '#/components/schemas/session_affinity_ttl'
                steering_policy:
                  $ref: '#/components/schemas/steering_policy'
                ttl:
                  $ref: '#/components/schemas/schemas-ttl'
      responses:
        4xx:
          description: Update Load Balancer response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/load-balancer_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Load Balancer response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/load-balancer_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/activation_check:
    put:
      tags:
      - Client
      summary: 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/identifier'
      responses:
        4xx:
          description: Client Error
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Successful Response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - type: object
                  properties:
                    result:
                      type: object
                      properties:
                        id:
                          $ref: '#/components/schemas/identifier'
  /zones/{zone_id}/api_gateway/configuration:
    get:
      tags:
      - API Shield Settings
      summary: Retrieve information about specific configuration properties
      operationId: api-shield-settings-retrieve-information-about-specific-configuration-properties
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Retrieve information about specific configuration properties
            response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Retrieve information about specific configuration properties
            response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - API Shield Settings
      summary: Set configuration properties
      operationId: api-shield-settings-set-configuration-properties
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/configuration'
      responses:
        4xx:
          description: Set configuration properties response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/default_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Set configuration properties response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/default_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/api_gateway/discovery:
    get:
      tags:
      - API Shield Endpoint Management
      summary: Retrieve API Discovery results for a zone
      description: Retrieve the most up to date view of API Discovery on a zone.
      operationId: api-shield-endpoint-management-retrieve-api-discovery-results-for-a-zone
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Retrieve API Discovery results for a zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schema_response_discovery'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Retrieve API Discovery results for a zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schema_response_discovery'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/api_gateway/operations:
    get:
      tags:
      - API Shield Endpoint Management
      summary: Retrieve information about all operations on a zone
      operationId: api-shield-endpoint-management-retrieve-information-about-all-operations-on-a-zone
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Retrieve information about all operations on a zone response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/collection_response_paginated'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Retrieve information about all operations on a zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collection_response_paginated'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - API Shield Endpoint Management
      summary: 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:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                type: object
                properties:
                  endpoint:
                    $ref: '#/components/schemas/endpoint'
                  host:
                    $ref: '#/components/schemas/host'
                  method:
                    $ref: '#/components/schemas/method'
              required:
              - host
              - method
              - endpoint
      responses:
        4xx:
          description: Add operations to a zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Add operations to a zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/api_gateway/operations/{operation_id}:
    delete:
      tags:
      - API Shield Endpoint Management
      summary: Delete an operation
      operationId: api-shield-endpoint-management-delete-an-operation
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/operation_id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete an operation response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/default_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an operation response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/default_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - API Shield Endpoint Management
      summary: Retrieve information about an operation
      operationId: api-shield-endpoint-management-retrieve-information-about-an-operation
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/operation_id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Retrieve information about an operation response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Retrieve information about an operation response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/api_gateway/schemas:
    get:
      tags:
      - API Shield Endpoint Management
      summary: Retrieve operations and features as OpenAPI schemas
      operationId: api-shield-endpoint-management-retrieve-operations-and-features-as-open-api-schemas
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Retrieve operations and features as OpenAPI schemas response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schema_response_with_thresholds'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Retrieve operations and features as OpenAPI schemas response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schema_response_with_thresholds'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/firewall/access_rules/rules:
    get:
      tags:
      - IP Access rules for a zone
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List IP Access rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List IP Access rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - IP Access rules for a zone
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - mode
              - configuration
              - notes
              properties:
                configuration:
                  $ref: '#/components/schemas/schemas-configuration'
                mode:
                  $ref: '#/components/schemas/schemas-mode'
                notes:
                  $ref: '#/components/schemas/notes'
      responses:
        4xx:
          description: Create an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/firewall/access_rules/rules/{identifier}:
    delete:
      tags:
      - IP Access rules for a zone
      summary: 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/rule_components-schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/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:
        4xx:
          description: Delete an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_single_id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_single_id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - IP Access rules for a zone
      summary: 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/rule_components-schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                mode:
                  $ref: '#/components/schemas/schemas-mode'
                notes:
                  $ref: '#/components/schemas/notes'
      responses:
        4xx:
          description: Update an IP Access rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update an IP Access rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/firewall/waf/packages/{package_id}/rules:
    get:
      tags:
      - WAF rules
      summary: List WAF rules
      description: Fetches WAF rules in a WAF package.
      operationId: waf-rules-list-waf-rules
      parameters:
      - name: package_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/package_components-schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List WAF rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List WAF rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/firewall/waf/packages/{package_id}/rules/{identifier}:
    get:
      tags:
      - WAF rules
      summary: Get a WAF rule
      description: Fetches the details of a WAF rule in a WAF package.
      operationId: waf-rules-get-a-waf-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rule_components-schemas-identifier-2'
      - name: package_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/package_components-schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a WAF rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a WAF rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - WAF rules
      summary: Update a WAF rule
      description: Updates a WAF rule. You can only update the mode/action of the
        rule.
      operationId: waf-rules-update-a-waf-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rule_components-schemas-identifier-2'
      - name: package_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/package_components-schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-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:
        4xx:
          description: Update a WAF rule response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/rule_response_single'
                  - properties:
                      result:
                        oneOf:
                        - $ref: '#/components/schemas/anomaly_rule'
                        - $ref: '#/components/schemas/traditional_deny_rule'
                        - $ref: '#/components/schemas/traditional_allow_rule'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a WAF rule response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_response_single'
                - properties:
                    result:
                      oneOf:
                      - $ref: '#/components/schemas/anomaly_rule'
                      - $ref: '#/components/schemas/traditional_deny_rule'
                      - $ref: '#/components/schemas/traditional_allow_rule'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/managed_headers:
    get:
      tags:
      - Managed Transforms
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Managed Transforms response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    managed_request_headers:
                      $ref: '#/components/schemas/request_list'
                    managed_response_headers:
                      $ref: '#/components/schemas/request_list'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Managed Transforms response
          content:
            application/json:
              schema:
                type: object
                properties:
                  managed_request_headers:
                    $ref: '#/components/schemas/request_list'
                  managed_response_headers:
                    $ref: '#/components/schemas/request_list'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Managed Transforms
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - managed_request_headers
              - managed_response_headers
              properties:
                managed_request_headers:
                  $ref: '#/components/schemas/request_list'
                managed_response_headers:
                  $ref: '#/components/schemas/request_list'
      responses:
        4xx:
          description: Update status of Managed Transforms response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    managed_request_headers:
                      $ref: '#/components/schemas/response_list'
                    managed_response_headers:
                      $ref: '#/components/schemas/response_list'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update status of Managed Transforms response
          content:
            application/json:
              schema:
                type: object
                properties:
                  managed_request_headers:
                    $ref: '#/components/schemas/response_list'
                  managed_response_headers:
                    $ref: '#/components/schemas/response_list'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/page_shield:
    get:
      tags:
      - Page Shield
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Page Shield settings response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/get-zone-settings-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Page Shield settings response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/get-zone-settings-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Page Shield
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                enabled:
                  $ref: '#/components/schemas/script-monitor_components-schemas-enabled'
                use_cloudflare_reporting_endpoint:
                  $ref: '#/components/schemas/use_cloudflare_reporting_endpoint'
                use_connection_url_path:
                  $ref: '#/components/schemas/use_connection_url_path'
      responses:
        4xx:
          description: Update Page Shield settings response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/update-zone-settings-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Page Shield settings response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/update-zone-settings-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/page_shield/connections:
    get:
      tags:
      - Page Shield
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Page Shield connections response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/list-zone-connections-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Page Shield connections response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-zone-connections-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/page_shield/connections/{id}:
    get:
      tags:
      - Page Shield
      summary: 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: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script-monitor_components-schemas-id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a Page Shield connection response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/get-zone-connection-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a Page Shield connection response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-zone-connection-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/page_shield/scripts:
    get:
      tags:
      - Page Shield
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Page Shield scripts response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/list-zone-scripts-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Page Shield scripts response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/list-zone-scripts-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/page_shield/scripts/{id}:
    get:
      tags:
      - Page Shield
      summary: 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: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/script-monitor_components-schemas-id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a Page Shield script response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/get-zone-script-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a Page Shield script response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get-zone-script-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/rulesets:
    get:
      tags:
      - Zone Rulesets
      summary: List zone rulesets
      description: Fetches all rulesets at the zone level.
      operationId: zone-rulesets-list-zone-rulesets
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List zone rulesets response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List zone rulesets response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone Rulesets
      summary: Create a zone ruleset
      description: Creates a ruleset at the zone level.
      operationId: zone-rulesets-create-a-zone-ruleset
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_ruleset'
      responses:
        4xx:
          description: Create a zone ruleset response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a zone ruleset response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/rulesets/{ruleset_id}:
    delete:
      tags:
      - Zone Rulesets
      summary: Delete a zone ruleset
      description: Deletes all versions of an existing zone ruleset.
      operationId: zone-rulesets-delete-a-zone-ruleset
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a zone ruleset response failure
          content:
            application/json: {}
        "200":
          description: Delete a zone ruleset response
          content:
            application/json: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zone Rulesets
      summary: Get a zone ruleset
      description: Fetches the latest version of a zone ruleset.
      operationId: zone-rulesets-get-a-zone-ruleset
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a zone ruleset response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a zone ruleset response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zone Rulesets
      summary: Update a zone ruleset
      description: Updates a zone ruleset, creating a new version.
      operationId: zone-rulesets-update-a-zone-ruleset
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_ruleset'
      responses:
        4xx:
          description: Update a zone ruleset response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a zone ruleset response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/rulesets/{ruleset_id}/rules:
    post:
      tags:
      - Zone Rulesets
      summary: 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.
      operationId: zone-rulesets-create-a-zone-ruleset-rule
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_update_rule'
      responses:
        4xx:
          description: Create a zone ruleset rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a zone ruleset rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/rulesets/{ruleset_id}/rules/{rule_id}:
    delete:
      tags:
      - Zone Rulesets
      summary: Delete a zone ruleset rule
      description: Deletes an existing rule from a zone ruleset.
      operationId: zone-rulesets-delete-a-zone-ruleset-rule
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-id'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a zone ruleset rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a zone ruleset rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Rulesets
      summary: Update a zone ruleset rule
      description: Updates an existing rule in a zone ruleset.
      operationId: zone-rulesets-update-a-zone-ruleset-rule
      parameters:
      - name: rule_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rules_components-schemas-id'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_update_rule'
      responses:
        4xx:
          description: Update a zone ruleset rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a zone ruleset rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/rulesets/{ruleset_id}/versions:
    get:
      tags:
      - Zone Rulesets
      summary: List a zone ruleset's versions
      description: Fetches the versions of a zone ruleset.
      operationId: zone-rulesets-list-a-zone-ruleset'-s-versions
      parameters:
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List a zone ruleset's versions response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List a zone ruleset's versions response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/rulesets/{ruleset_id}/versions/{ruleset_version}:
    delete:
      tags:
      - Zone Rulesets
      summary: Delete a zone ruleset version
      description: Deletes an existing version of a zone ruleset.
      operationId: zone-rulesets-delete-a-zone-ruleset-version
      parameters:
      - name: ruleset_version
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/version'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a zone ruleset version response failure
          content:
            application/json: {}
        "200":
          description: Delete a zone ruleset version response
          content:
            application/json: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zone Rulesets
      summary: Get a zone ruleset version
      description: Fetches a specific version of a zone ruleset.
      operationId: zone-rulesets-get-a-zone-ruleset-version
      parameters:
      - name: ruleset_version
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/version'
      - name: ruleset_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/rulesets_components-schemas-id'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a zone ruleset version response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a zone ruleset version response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/rulesets/phases/{phase}/entrypoint:
    get:
      tags:
      - Transform Rules
      summary: List Transform Rules
      description: Fetches all Transform Rules in a zone.
      operationId: transform-rules-list-transform-rules
      parameters:
      - name: phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-phase'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Transform Rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-ruleset'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Transform Rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-ruleset'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Transform Rules
      summary: Update Transform Rules
      description: Updates the Transform Rules of a zone.
      operationId: transform-rules-update-transform-rules
      parameters:
      - name: phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/schemas-phase'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_ruleset'
      responses:
        4xx:
          description: Update Transform Rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Transform Rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint:
    get:
      tags:
      - Zone Rulesets
      summary: Get a zone entry point ruleset
      description: Fetches the latest version of the zone entry point ruleset for
        a given phase.
      operationId: zone-rulesets-get-a-zone-entry-point-ruleset
      parameters:
      - name: ruleset_phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/phase'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a zone entry point ruleset response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a zone entry point ruleset response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zone Rulesets
      summary: Update a zone entry point ruleset
      description: Updates a zone entry point ruleset, creating a new version.
      operationId: zone-rulesets-update-a-zone-entry-point-ruleset
      parameters:
      - name: ruleset_phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/phase'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_ruleset'
      responses:
        4xx:
          description: Update a zone entry point ruleset response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a zone entry point ruleset response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions:
    get:
      tags:
      - Zone Rulesets
      summary: List a zone entry point ruleset's versions
      description: Fetches the versions of a zone entry point ruleset.
      operationId: zone-rulesets-list-a-zone-entry-point-ruleset'-s-versions
      parameters:
      - name: ruleset_phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/phase'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List a zone entry point ruleset's versions response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rulesets_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List a zone entry point ruleset's versions response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rulesets_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/rulesets/phases/{ruleset_phase}/entrypoint/versions/{ruleset_version}:
    get:
      tags:
      - Zone Rulesets
      summary: Get a zone entry point ruleset version
      description: Fetches a specific version of a zone entry point ruleset.
      operationId: zone-rulesets-get-a-zone-entry-point-ruleset-version
      parameters:
      - name: ruleset_version
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/version'
      - name: ruleset_phase
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/phase'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a zone entry point ruleset version response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ruleset_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a zone entry point ruleset version response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ruleset_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/rulesets/phases/http_custom_errors/entrypoint:
    get:
      tags:
      - Custom Error Responses
      summary: Get Custom Error Responses
      description: Fetches all Custom Error Responses in a zone.
      operationId: custom-error-responses-get-custom-error-responses
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Custom Error Responses response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-ruleset'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Custom Error Responses response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-ruleset'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Custom Error Responses
      summary: Update Custom Error Responses
      description: Updates the Custom Error Responses of a zone.
      operationId: custom-error-responses-update-custom-error-responses
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_ruleset'
      responses:
        4xx:
          description: Update Custom Error Responses response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Custom Error Responses response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/url_normalization:
    get:
      tags:
      - URL Normalization
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get URL normalization settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-response_model'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get URL normalization settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-response_model'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - URL Normalization
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/schemas-request_model'
      responses:
        4xx:
          description: Update URL normalization settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-response_model'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update URL normalization settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-response_model'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/workers/filters:
    get:
      tags:
      - Worker Filters (Deprecated)
      summary: List Filters
      operationId: worker-filters-(-deprecated)-list-filters
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Filters response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Filters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-response-collection'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Worker Filters (Deprecated)
      summary: Create Filter
      operationId: worker-filters-(-deprecated)-create-filter
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/filter-no-id'
      responses:
        4xx:
          description: Create Filter response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Filter response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/workers/filters/{filter_id}:
    delete:
      tags:
      - Worker Filters (Deprecated)
      summary: Delete Filter
      operationId: worker-filters-(-deprecated)-delete-filter
      parameters:
      - name: filter_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Filter response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Filter response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Worker Filters (Deprecated)
      summary: Update Filter
      operationId: worker-filters-(-deprecated)-update-filter
      parameters:
      - name: filter_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/filter-no-id'
      responses:
        4xx:
          description: Update Filter response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Filter response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-response-single'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/workers/routes:
    get:
      tags:
      - Worker Routes
      summary: List Routes
      operationId: worker-routes-list-routes
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Routes response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/route-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Routes response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Worker Routes
      summary: Create Route
      operationId: worker-routes-create-route
      parameters:
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/route-no-id'
      responses:
        4xx:
          description: Create Route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_id}/workers/routes/{route_id}:
    delete:
      tags:
      - Worker Routes
      summary: Delete Route
      operationId: worker-routes-delete-route
      parameters:
      - name: route_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Worker Routes
      summary: Get Route
      operationId: worker-routes-get-route
      parameters:
      - name: route_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/route-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Worker Routes
      summary: Update Route
      operationId: worker-routes-update-route
      parameters:
      - name: route_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/route-no-id'
      responses:
        4xx:
          description: Update Route response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/route-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Route response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/route-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/acm/total_tls:
    get:
      tags:
      - Total TLS
      summary: Total TLS Settings Details
      description: Get Total TLS Settings for a Zone.
      operationId: total-tls-total-tls-settings-details
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Total TLS Settings Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/total_tls_settings_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Total TLS Settings Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/total_tls_settings_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Total TLS
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - enabled
              properties:
                certificate_authority:
                  $ref: '#/components/schemas/schemas-certificate_authority'
                enabled:
                  $ref: '#/components/schemas/total-tls_components-schemas-enabled'
      responses:
        4xx:
          description: Enable or Disable Total TLS response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/total_tls_settings_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Enable or Disable Total TLS response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/total_tls_settings_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/analytics/colos:
    get:
      tags:
      - Zone Analytics (Deprecated)
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get analytics by Co-locations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/colo_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get analytics by Co-locations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/colo_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/analytics/dashboard:
    get:
      tags:
      - Zone Analytics (Deprecated)
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get dashboard response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dashboard_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get dashboard response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dashboard_response'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/analytics/latency:
    get:
      tags:
      - Argo Analytics for Zone
      summary: Argo Analytics for a zone
      operationId: argo-analytics-for-zone-argo-analytics-for-a-zone
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Argo Analytics for a zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Argo Analytics for a zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/analytics/latency/colos:
    get:
      tags:
      - Argo Analytics for Geolocation
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Argo Analytics for a zone at different PoPs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Argo Analytics for a zone at different PoPs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/argo/smart_routing:
    get:
      tags:
      - Argo Smart Routing
      summary: Get Argo Smart Routing setting
      operationId: argo-smart-routing-get-argo-smart-routing-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Argo Smart Routing setting response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Argo Smart Routing setting response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Argo Smart Routing
      summary: Patch Argo Smart Routing setting
      description: Updates enablement of Argo Smart Routing.
      operationId: argo-smart-routing-patch-argo-smart-routing-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patch'
      responses:
        4xx:
          description: Patch Argo Smart Routing setting response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch Argo Smart Routing setting response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/available_plans:
    get:
      tags:
      - Zone Rate Plan
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Available Plans response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-collection'
                  - properties:
                      result:
                        type: array
                        items:
                          $ref: '#/components/schemas/available-rate-plan'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Available Plans response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-collection'
                - properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/available-rate-plan'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/available_plans/{plan_identifier}:
    get:
      tags:
      - Zone Rate Plan
      summary: 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/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Available Plan Details response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/available-rate-plan'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Available Plan Details response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - properties:
                    result:
                      $ref: '#/components/schemas/available-rate-plan'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/available_rate_plans:
    get:
      tags:
      - Zone Rate Plan
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Available Rate Plans response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/plan_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Available Rate Plans response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/plan_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/cache/cache_reserve:
    get:
      tags:
      - Zone Cache Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Cache Reserve setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/cache_reserve_response_value'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Cache Reserve setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_reserve_response_value'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Cache Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/cache_reserve_value'
      responses:
        4xx:
          description: Change Cache Reserve setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/cache_reserve_response_value'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Cache Reserve setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_cache_settings_response_single'
                - $ref: '#/components/schemas/cache_reserve_response_value'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/cache/variants:
    delete:
      tags:
      - Zone Cache Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete variants setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_cache_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/variants'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete variants setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_cache_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/variants'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zone Cache Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get variants setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/variants_response_value'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get variants setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_cache_settings_response_single'
                - $ref: '#/components/schemas/variants_response_value'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Cache Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/variants_value'
      responses:
        4xx:
          description: Change variants setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_cache_settings_response_single'
                  - $ref: '#/components/schemas/variants_response_value'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change variants setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_cache_settings_response_single'
                - $ref: '#/components/schemas/variants_response_value'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/custom_certificates:
    get:
      tags:
      - Custom SSL for a Zone
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List SSL Configurations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List SSL Configurations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Custom SSL for a Zone
      summary: Create SSL Configuration
      description: Upload a new SSL certificate for a zone.
      operationId: custom-ssl-for-a-zone-create-ssl-configuration
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - certificate
              - private_key
              properties:
                bundle_method:
                  $ref: '#/components/schemas/bundle_method'
                certificate:
                  $ref: '#/components/schemas/certificate'
                geo_restrictions:
                  $ref: '#/components/schemas/geo_restrictions'
                policy:
                  $ref: '#/components/schemas/policy'
                private_key:
                  $ref: '#/components/schemas/private_key'
                type:
                  $ref: '#/components/schemas/custom-certificate_components-schemas-type'
      responses:
        4xx:
          description: Create SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/custom_certificates/{identifier}:
    delete:
      tags:
      - Custom SSL for a Zone
      summary: Delete SSL Configuration
      description: Remove a SSL certificate from a zone.
      operationId: custom-ssl-for-a-zone-delete-ssl-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-certificate_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_response_id_only'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_response_id_only'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Custom SSL for a Zone
      summary: SSL Configuration Details
      operationId: custom-ssl-for-a-zone-ssl-configuration-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-certificate_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: SSL Configuration Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: SSL Configuration Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Custom SSL for a Zone
      summary: 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: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-certificate_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                bundle_method:
                  $ref: '#/components/schemas/bundle_method'
                certificate:
                  $ref: '#/components/schemas/certificate'
                geo_restrictions:
                  $ref: '#/components/schemas/geo_restrictions'
                policy:
                  $ref: '#/components/schemas/policy'
                private_key:
                  $ref: '#/components/schemas/private_key'
      responses:
        4xx:
          description: Edit SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/custom_certificates/prioritize:
    put:
      tags:
      - Custom SSL for a Zone
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-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/custom-certificate_components-schemas-identifier'
                      priority:
                        $ref: '#/components/schemas/schemas-priority'
      responses:
        4xx:
          description: Re-prioritize SSL Certificates response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Re-prioritize SSL Certificates response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/custom_hostnames:
    get:
      tags:
      - Custom Hostname for a Zone
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Custom Hostnames response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom_hostname_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Custom Hostnames response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_hostname_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Custom Hostname for a Zone
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - hostname
              - ssl
              properties:
                hostname:
                  $ref: '#/components/schemas/hostname'
                ssl:
                  $ref: '#/components/schemas/sslpost'
      responses:
        4xx:
          description: Create Custom Hostname response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom_hostname_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Custom Hostname response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_hostname_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/custom_hostnames/{identifier}:
    delete:
      tags:
      - Custom Hostname for a Zone
      summary: Delete Custom Hostname (and any issued SSL certificates)
      operationId: custom-hostname-for-a-zone-delete-custom-hostname-(-and-any-issued-ssl-certificates)
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-hostname_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Custom Hostname (and any issued SSL certificates) response
            failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    id:
                      $ref: '#/components/schemas/custom-hostname_components-schemas-identifier'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Custom Hostname (and any issued SSL certificates) response
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    $ref: '#/components/schemas/custom-hostname_components-schemas-identifier'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Custom Hostname for a Zone
      summary: Custom Hostname Details
      operationId: custom-hostname-for-a-zone-custom-hostname-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-hostname_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Custom Hostname Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom_hostname_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Custom Hostname Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_hostname_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Custom Hostname for a Zone
      summary: 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: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/custom-hostname_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                custom_metadata:
                  $ref: '#/components/schemas/custom_metadata'
                custom_origin_server:
                  $ref: '#/components/schemas/custom_origin_server'
                custom_origin_sni:
                  $ref: '#/components/schemas/custom_origin_sni'
                ssl:
                  $ref: '#/components/schemas/sslpost'
      responses:
        4xx:
          description: Edit Custom Hostname response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom_hostname_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit Custom Hostname response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_hostname_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/custom_hostnames/fallback_origin:
    delete:
      tags:
      - Custom Hostname Fallback Origin for a Zone
      summary: Delete Fallback Origin for Custom Hostnames
      operationId: custom-hostname-fallback-origin-for-a-zone-delete-fallback-origin-for-custom-hostnames
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Fallback Origin for Custom Hostnames response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fallback_origin_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Fallback Origin for Custom Hostnames response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fallback_origin_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Custom Hostname Fallback Origin for a Zone
      summary: Get Fallback Origin for Custom Hostnames
      operationId: custom-hostname-fallback-origin-for-a-zone-get-fallback-origin-for-custom-hostnames
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Fallback Origin for Custom Hostnames response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fallback_origin_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Fallback Origin for Custom Hostnames response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fallback_origin_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Custom Hostname Fallback Origin for a Zone
      summary: Update Fallback Origin for Custom Hostnames
      operationId: custom-hostname-fallback-origin-for-a-zone-update-fallback-origin-for-custom-hostnames
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - origin
              properties:
                origin:
                  $ref: '#/components/schemas/origin'
      responses:
        4xx:
          description: Update Fallback Origin for Custom Hostnames response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fallback_origin_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Fallback Origin for Custom Hostnames response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fallback_origin_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/custom_ns:
    get:
      tags:
      - Account-Level Custom Nameservers Usage for a Zone
      summary: Get Account Custom Nameserver Related Zone Metadata
      operationId: account-level-custom-nameservers-usage-for-a-zone-get-account-custom-nameserver-related-zone-metadata
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Account Custom Nameserver Related Zone Metadata response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/get_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Account Custom Nameserver Related Zone Metadata response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Account-Level Custom Nameservers Usage for a Zone
      summary: Set Account Custom Nameserver Related Zone Metadata
      operationId: account-level-custom-nameservers-usage-for-a-zone-set-account-custom-nameserver-related-zone-metadata
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/zone_metadata'
      responses:
        4xx:
          description: Set Account Custom Nameserver Related Zone Metadata response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/empty_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Set Account Custom Nameserver Related Zone Metadata response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/empty_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/custom_pages:
    get:
      tags:
      - Custom pages for a zone
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List custom pages response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom_pages_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List custom pages response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_pages_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/custom_pages/{identifier}:
    get:
      tags:
      - Custom pages for a zone
      summary: 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_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a custom page response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom_pages_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a custom page response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_pages_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Custom pages for a zone
      summary: 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_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - url
              - state
              properties:
                state:
                  $ref: '#/components/schemas/schemas-state'
                url:
                  $ref: '#/components/schemas/url'
      responses:
        4xx:
          description: Update a custom page response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/custom_pages_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a custom page response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/custom_pages_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/dns_records:
    get:
      tags:
      - DNS Records for a Zone
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List DNS Records response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List DNS Records response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - DNS Records for a Zone
      summary: Create DNS Record
      description: Create a new DNS record for a zone. See the record object definitions
        for required attributes for each record type.
      operationId: dns-records-for-a-zone-create-dns-record
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - type
              - name
              - content
              - ttl
              properties:
                content:
                  $ref: '#/components/schemas/content'
                name:
                  $ref: '#/components/schemas/dns-record_components-schemas-name'
                priority:
                  $ref: '#/components/schemas/priority'
                proxied:
                  $ref: '#/components/schemas/proxied'
                ttl:
                  $ref: '#/components/schemas/ttl'
                type:
                  $ref: '#/components/schemas/dns-record_components-schemas-type'
      responses:
        4xx:
          description: Create DNS Record response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create DNS Record response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/dns_records/{identifier}:
    delete:
      tags:
      - DNS Records for a Zone
      summary: Delete DNS Record
      operationId: dns-records-for-a-zone-delete-dns-record
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-record_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete DNS Record response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/dns-record_components-schemas-identifier'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete DNS Record response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    properties:
                      id:
                        $ref: '#/components/schemas/dns-record_components-schemas-identifier'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - DNS Records for a Zone
      summary: DNS Record Details
      operationId: dns-records-for-a-zone-dns-record-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-record_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: DNS Record Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: DNS Record Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - DNS Records for a Zone
      summary: Patch DNS Record
      operationId: dns-records-for-a-zone-patch-dns-record
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-record_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                content:
                  $ref: '#/components/schemas/content'
                name:
                  $ref: '#/components/schemas/dns-record_components-schemas-name'
                proxied:
                  $ref: '#/components/schemas/proxied'
                ttl:
                  $ref: '#/components/schemas/ttl'
                type:
                  $ref: '#/components/schemas/dns-record_components-schemas-type'
      responses:
        4xx:
          description: Patch DNS Record response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch DNS Record response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - DNS Records for a Zone
      summary: Update DNS Record
      operationId: dns-records-for-a-zone-update-dns-record
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dns-record_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - type
              - name
              - content
              - ttl
              properties:
                content:
                  $ref: '#/components/schemas/content'
                name:
                  $ref: '#/components/schemas/dns-record_components-schemas-name'
                proxied:
                  $ref: '#/components/schemas/proxied'
                ttl:
                  $ref: '#/components/schemas/ttl'
                type:
                  $ref: '#/components/schemas/dns-record_components-schemas-type'
      responses:
        4xx:
          description: Update DNS Record response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update DNS Record response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/dns_records/export:
    get:
      tags:
      - DNS Records for a Zone
      summary: Export DNS Records
      description: You can export your [BIND config](https://en.wikipedia.org/wiki/Zone_file
        "Zone file") through this endpoint.
      operationId: dns-records-for-a-zone-export-dns-records
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Export DNS Records response failure
          content:
            application/json:
              schema:
                allOf:
                - {}
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Export DNS Records response
          content:
            application/json:
              schema: {}
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/dns_records/import:
    post:
      tags:
      - DNS Records for a Zone
      summary: 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.
      operationId: dns-records-for-a-zone-import-dns-records
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              required:
              - file
              properties:
                file:
                  type: string
                  description: BIND config to upload.
                  example: '@bind_config.txt'
                proxied:
                  type: boolean
                  description: Whether or not proxiable records should receive the
                    performance and security benefits of Cloudflare.
                  example: false
      responses:
        4xx:
          description: Import DNS Records response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_response_import_scan'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Import DNS Records response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns_response_import_scan'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/dns_records/scan:
    post:
      tags:
      - DNS Records for a Zone
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Scan DNS Records response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns_response_import_scan'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Scan DNS Records response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns_response_import_scan'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/dnssec:
    delete:
      tags:
      - DNSSEC
      summary: Delete DNSSEC records
      description: Delete DNSSEC.
      operationId: dnssec-delete-dnssec-records
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete DNSSEC records response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/delete_dnssec_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete DNSSEC records response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/delete_dnssec_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - DNSSEC
      summary: DNSSEC Details
      description: Details about DNSSEC status and configuration.
      operationId: dnssec-dnssec-details
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: DNSSEC Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dnssec_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: DNSSEC Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dnssec_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - DNSSEC
      summary: Edit DNSSEC Status
      description: Enable or disable DNSSEC.
      operationId: dnssec-edit-dnssec-status
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - status
              properties:
                status:
                  description: Status of DNSSEC, based on user-desired state and presence
                    of necessary records.
                  enum:
                  - active
                  - disabled
                  example: active
      responses:
        4xx:
          description: Edit DNSSEC Status response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dnssec_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit DNSSEC Status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dnssec_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/email/routing:
    get:
      tags:
      - Email Routing settings
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Email Routing settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-settings_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Email Routing settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email-settings_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/email/routing/disable:
    post:
      tags:
      - Email Routing settings
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Disable Email Routing response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-settings_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Disable Email Routing response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email-settings_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/email/routing/dns:
    get:
      tags:
      - Email Routing settings
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: Email Routing - DNS settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/dns-settings_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Email Routing - DNS settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/dns-settings_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/email/routing/enable:
    post:
      tags:
      - Email Routing settings
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Enable Email Routing response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/email-settings_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Enable Email Routing response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/email-settings_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/email/routing/rules:
    get:
      tags:
      - Email Routing routing rules
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List routing rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rules_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List routing rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rules_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Email Routing routing rules
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_rule_properties'
      responses:
        4xx:
          description: Create routing rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create routing rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/email/routing/rules/{rule_identifier}:
    delete:
      tags:
      - Email Routing routing rules
      summary: 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/rule_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete routing rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete routing rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Email Routing routing rules
      summary: 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/rule_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get routing rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get routing rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Email Routing routing rules
      summary: 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/rule_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_rule_properties'
      responses:
        4xx:
          description: Update routing rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update routing rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/email/routing/rules/catch_all:
    get:
      tags:
      - Email Routing routing rules
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get catch-all rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/catch_all_rule_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get catch-all rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/catch_all_rule_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Email Routing routing rules
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_catch_all_rule_properties'
      responses:
        4xx:
          description: Update catch-all rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/catch_all_rule_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update catch-all rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/catch_all_rule_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/filters:
    delete:
      tags:
      - Filters
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  $ref: '#/components/schemas/filters_components-schemas-id'
      responses:
        4xx:
          description: Delete filters response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-delete-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete filters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-delete-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Filters
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List filters response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-filter-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List filters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-filter-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Filters
      summary: Create filters
      description: Creates one or more filters.
      operationId: filters-create-filters
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - expression
      responses:
        4xx:
          description: Create filters response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-filter-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create filters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-filter-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Filters
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        4xx:
          description: Update filters response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-filter-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update filters response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-filter-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/filters/{id}:
    delete:
      tags:
      - Filters
      summary: Delete a filter
      description: Deletes an existing filter.
      operationId: filters-delete-a-filter
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/filters_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a filter response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-delete-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a filter response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-delete-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Filters
      summary: 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/filters_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a filter response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-filter-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a filter response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-filter-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Filters
      summary: Update a filter
      description: Updates an existing filter.
      operationId: filters-update-a-filter
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/filters_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        4xx:
          description: Update a filter response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-filter-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a filter response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-filter-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/lockdowns:
    get:
      tags:
      - Zone Lockdown
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Zone Lockdown rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zonelockdown_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Zone Lockdown rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zonelockdown_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone Lockdown
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - urls
              - configurations
      responses:
        4xx:
          description: Create a Zone Lockdown rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zonelockdown_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a Zone Lockdown rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zonelockdown_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/lockdowns/{id}:
    delete:
      tags:
      - Zone Lockdown
      summary: 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/lockdowns_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a Zone Lockdown rule response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/lockdowns_components-schemas-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a Zone Lockdown rule response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    properties:
                      id:
                        $ref: '#/components/schemas/lockdowns_components-schemas-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zone Lockdown
      summary: 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/lockdowns_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a Zone Lockdown rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zonelockdown_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a Zone Lockdown rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zonelockdown_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zone Lockdown
      summary: 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/lockdowns_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - urls
              - configurations
      responses:
        4xx:
          description: Update a Zone Lockdown rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zonelockdown_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a Zone Lockdown rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zonelockdown_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/rules:
    delete:
      tags:
      - Firewall rules
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - id
              properties:
                id:
                  $ref: '#/components/schemas/firewall-rules_components-schemas-id'
      responses:
        4xx:
          description: Delete firewall rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-rules-response-collection-delete'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete firewall rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-rules-response-collection-delete'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Firewall rules
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List firewall rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-rules-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List firewall rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-rules-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Firewall rules
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        4xx:
          description: Update priority of firewall rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-rules-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update priority of firewall rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-rules-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Firewall rules
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - filter
              - action
      responses:
        4xx:
          description: Create firewall rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-rules-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create firewall rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-rules-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Firewall rules
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        4xx:
          description: Update firewall rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-rules-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update firewall rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-rules-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/rules/{id}:
    delete:
      tags:
      - Firewall rules
      summary: 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/firewall-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                delete_filter_if_unused:
                  $ref: '#/components/schemas/delete_filter_if_unused'
      responses:
        4xx:
          description: Delete a firewall rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-rules-single-response-delete'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a firewall rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-rules-single-response-delete'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Firewall rules
      summary: 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/firewall-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a firewall rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-rules-single-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a firewall rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-rules-single-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Firewall rules
      summary: 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/firewall-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
      responses:
        4xx:
          description: Update priority of a firewall rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-rules-response-collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update priority of a firewall rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-rules-response-collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Firewall rules
      summary: 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/firewall-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
              - filter
              - action
      responses:
        4xx:
          description: Update a firewall rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/filter-rules-single-response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a firewall rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/filter-rules-single-response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/ua_rules:
    get:
      tags:
      - User Agent Blocking rules
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List User Agent Blocking rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/firewalluablock_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List User Agent Blocking rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewalluablock_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - User Agent Blocking rules
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - mode
              - configuration
      responses:
        4xx:
          description: Create a User Agent Blocking rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/firewalluablock_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a User Agent Blocking rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewalluablock_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/ua_rules/{id}:
    delete:
      tags:
      - User Agent Blocking rules
      summary: 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/ua-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a User Agent Blocking rule response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/firewalluablock_response_single'
                  - type: object
                    properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/ua-rules_components-schemas-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a User Agent Blocking rule response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/firewalluablock_response_single'
                - type: object
                  properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/ua-rules_components-schemas-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - User Agent Blocking rules
      summary: 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/ua-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a User Agent Blocking rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/firewalluablock_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a User Agent Blocking rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewalluablock_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - User Agent Blocking rules
      summary: 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/ua-rules_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
              - mode
              - configuration
      responses:
        4xx:
          description: Update a User Agent Blocking rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/firewalluablock_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a User Agent Blocking rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/firewalluablock_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/waf/overrides:
    get:
      tags:
      - WAF overrides
      summary: List WAF overrides
      description: Fetches the URI-based WAF overrides in a zone.
      operationId: waf-overrides-list-waf-overrides
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List WAF overrides response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/override_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List WAF overrides response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/override_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - WAF overrides
      summary: Create a WAF override
      description: Creates a URI-based WAF override for a zone.
      operationId: waf-overrides-create-a-waf-override
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - urls
      responses:
        4xx:
          description: Create a WAF override response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/override_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a WAF override response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/override_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/waf/overrides/{id}:
    delete:
      tags:
      - WAF overrides
      summary: Delete a WAF override
      description: Deletes an existing URI-based WAF override.
      operationId: waf-overrides-delete-a-waf-override
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/overrides_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a WAF override response failure
          content:
            application/json:
              schema:
                allOf:
                - type: object
                  properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/overrides_components-schemas-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a WAF override response
          content:
            application/json:
              schema:
                type: object
                properties:
                  result:
                    properties:
                      id:
                        $ref: '#/components/schemas/overrides_components-schemas-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - WAF overrides
      summary: Get a WAF override
      description: Fetches the details of a URI-based WAF override.
      operationId: waf-overrides-get-a-waf-override
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/overrides_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a WAF override response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/override_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a WAF override response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/override_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - WAF overrides
      summary: Update WAF override
      description: Updates an existing URI-based WAF override.
      operationId: waf-overrides-update-waf-override
      parameters:
      - name: id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/overrides_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
              - urls
              - rules
              - rewrite_action
      responses:
        4xx:
          description: Update WAF override response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/override_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update WAF override response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/override_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/waf/packages:
    get:
      tags:
      - WAF packages
      summary: List WAF packages
      description: Fetches WAF packages for a zone.
      operationId: waf-packages-list-waf-packages
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List WAF packages response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/package_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List WAF packages response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/package_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/waf/packages/{identifier}:
    get:
      tags:
      - WAF packages
      summary: Get a WAF package
      description: Fetches the details of a WAF package.
      operationId: waf-packages-get-a-waf-package
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/package_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a WAF package response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/package_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a WAF package response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/package_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - WAF packages
      summary: Update a WAF package
      description: Updates a WAF package. You can update the sensitivity and the action
        of an anomaly detection WAF package.
      operationId: waf-packages-update-a-waf-package
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/package_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                action_mode:
                  $ref: '#/components/schemas/action_mode'
                sensitivity:
                  $ref: '#/components/schemas/sensitivity'
      responses:
        4xx:
          description: Update a WAF package response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/package_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/anomaly_package'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a WAF package response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/package_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/anomaly_package'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/waf/packages/{package_identifier}/groups:
    get:
      tags:
      - WAF rule groups
      summary: List WAF rule groups
      description: Fetches the WAF rule groups in a WAF package.
      operationId: waf-rule-groups-list-waf-rule-groups
      parameters:
      - name: package_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/package_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List WAF rule groups response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_group_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List WAF rule groups response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_group_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/firewall/waf/packages/{package_identifier}/groups/{identifier}:
    get:
      tags:
      - WAF rule groups
      summary: Get a WAF rule group
      description: Fetches the details of a WAF rule group.
      operationId: waf-rule-groups-get-a-waf-rule-group
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/group_components-schemas-identifier'
      - name: package_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/package_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a WAF rule group response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_group_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a WAF rule group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_group_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - WAF rule groups
      summary: Update a WAF rule group
      description: Updates a WAF rule group. You can update the state (`mode` parameter)
        of a rule group.
      operationId: waf-rule-groups-update-a-waf-rule-group
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/group_components-schemas-identifier'
      - name: package_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/package_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                mode:
                  $ref: '#/components/schemas/components-schemas-mode'
      responses:
        4xx:
          description: Update a WAF rule group response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/rule_group_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a WAF rule group response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/rule_group_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/healthchecks:
    get:
      tags:
      - Health Checks
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Health Checks response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Health Checks response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Health Checks
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_healthcheck'
      responses:
        4xx:
          description: Create Health Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Health Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/healthchecks/{identifier}:
    delete:
      tags:
      - Health Checks
      summary: 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_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Health Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Health Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Health Checks
      summary: 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_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Health Check Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Health Check Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Health Checks
      summary: 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_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_healthcheck'
      responses:
        4xx:
          description: Patch Health Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch Health Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Health Checks
      summary: 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_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_healthcheck'
      responses:
        4xx:
          description: Update Health Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Health Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/healthchecks/preview:
    post:
      tags:
      - Health Checks
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_healthcheck'
      responses:
        4xx:
          description: Create Preview Health Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Preview Health Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/healthchecks/preview/{identifier}:
    delete:
      tags:
      - Health Checks
      summary: 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_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Preview Health Check response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_components-schemas-id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Preview Health Check response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_components-schemas-id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Health Checks
      summary: 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_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Health Check Preview Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/healthchecks_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Health Check Preview Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthchecks_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/keyless_certificates:
    get:
      tags:
      - Keyless SSL for a Zone
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Keyless SSL Configurations response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/keyless_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Keyless SSL Configurations response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keyless_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Keyless SSL for a Zone
      summary: Create Keyless SSL Configuration
      operationId: keyless-ssl-for-a-zone-create-keyless-ssl-configuration
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - host
              - port
              - certificate
              properties:
                bundle_method:
                  $ref: '#/components/schemas/bundle_method'
                certificate:
                  $ref: '#/components/schemas/schemas-certificate'
                host:
                  $ref: '#/components/schemas/schemas-host'
                name:
                  $ref: '#/components/schemas/keyless-certificate_components-schemas-name'
                port:
                  $ref: '#/components/schemas/schemas-port'
      responses:
        4xx:
          description: Create Keyless SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/keyless_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Keyless SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keyless_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/keyless_certificates/{identifier}:
    delete:
      tags:
      - Keyless SSL for a Zone
      summary: Delete Keyless SSL Configuration
      operationId: keyless-ssl-for-a-zone-delete-keyless-ssl-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/keyless-certificate_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Keyless SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/keyless_response_single_id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Keyless SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keyless_response_single_id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Keyless SSL for a Zone
      summary: Get Keyless SSL Configuration
      description: Get details for one Keyless SSL configuration.
      operationId: keyless-ssl-for-a-zone-get-keyless-ssl-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/keyless-certificate_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Keyless SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/keyless_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Keyless SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keyless_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Keyless SSL for a Zone
      summary: Edit Keyless SSL Configuration
      description: 'This will update attributes of a Keyless SSL. Consists of one
        or more of the following:  host,name,port,certificate,enabled.'
      operationId: keyless-ssl-for-a-zone-edit-keyless-ssl-configuration
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/keyless-certificate_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                enabled:
                  $ref: '#/components/schemas/schemas-enabled'
                host:
                  $ref: '#/components/schemas/schemas-host'
                name:
                  $ref: '#/components/schemas/keyless-certificate_components-schemas-name'
                port:
                  $ref: '#/components/schemas/schemas-port'
      responses:
        4xx:
          description: Edit Keyless SSL Configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/keyless_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit Keyless SSL Configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/keyless_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/logpush/datasets/{dataset}/fields:
    get:
      tags:
      - Logpush Jobs
      summary: 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: logpush-jobs-list-fields
      parameters:
      - name: dataset
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dataset'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List fields response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_field_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List fields response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_field_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/logpush/datasets/{dataset}/jobs:
    get:
      tags:
      - Logpush Jobs
      summary: List Logpush jobs for a dataset
      description: Lists Logpush jobs for a zone for a dataset.
      operationId: logpush-jobs-list-logpush-jobs-for-a-dataset
      parameters:
      - name: dataset
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/dataset'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Logpush jobs for a dataset response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_job_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Logpush jobs for a dataset response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_job_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/logpush/jobs:
    get:
      tags:
      - Logpush Jobs
      summary: List Logpush jobs
      description: Lists Logpush jobs for a zone.
      operationId: logpush-jobs-list-logpush-jobs
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Logpush jobs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_job_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Logpush jobs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_job_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Logpush Jobs
      summary: Create Logpush job
      description: Creates a new Logpush job for a zone.
      operationId: logpush-jobs-create-logpush-job
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - destination_conf
              properties:
                dataset:
                  $ref: '#/components/schemas/dataset'
                destination_conf:
                  $ref: '#/components/schemas/destination_conf'
                enabled:
                  $ref: '#/components/schemas/enabled'
                frequency:
                  $ref: '#/components/schemas/components-schemas-frequency'
                logpull_options:
                  $ref: '#/components/schemas/logpull_options'
                name:
                  $ref: '#/components/schemas/logpush_components-schemas-name'
                ownership_challenge:
                  $ref: '#/components/schemas/ownership_challenge'
      responses:
        4xx:
          description: Create Logpush job response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_job_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Logpush job response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_job_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/logpush/jobs/{job_identifier}:
    delete:
      tags:
      - Logpush Jobs
      summary: Delete Logpush job
      description: Deletes a Logpush job.
      operationId: logpush-jobs-delete-logpush-job
      parameters:
      - name: job_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Logpush job response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-common'
                  - properties:
                      result:
                        type: object
                        example: {}
                        nullable: true
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Logpush job response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-common'
                - properties:
                    result:
                      type: object
                      example: {}
                      nullable: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Logpush Jobs
      summary: Get Logpush job details
      description: Gets the details of a Logpush job.
      operationId: logpush-jobs-get-logpush-job-details
      parameters:
      - name: job_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Logpush job details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_job_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Logpush job details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_job_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Logpush Jobs
      summary: Update Logpush job
      description: Updates a Logpush job.
      operationId: logpush-jobs-update-logpush-job
      parameters:
      - name: job_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              properties:
                destination_conf:
                  $ref: '#/components/schemas/destination_conf'
                enabled:
                  $ref: '#/components/schemas/enabled'
                frequency:
                  $ref: '#/components/schemas/components-schemas-frequency'
                logpull_options:
                  $ref: '#/components/schemas/logpull_options'
                ownership_challenge:
                  $ref: '#/components/schemas/ownership_challenge'
      responses:
        4xx:
          description: Update Logpush job response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logpush_job_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Logpush job response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logpush_job_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/logpush/ownership:
    post:
      tags:
      - Logpush Jobs
      summary: Get ownership challenge
      description: Gets a new ownership challenge sent to your destination.
      operationId: logpush-jobs-get-ownership-challenge
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - destination_conf
              properties:
                destination_conf:
                  $ref: '#/components/schemas/destination_conf'
      responses:
        4xx:
          description: Get ownership challenge response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/get_ownership_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get ownership challenge response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/get_ownership_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/logpush/ownership/validate:
    post:
      tags:
      - Logpush Jobs
      summary: Validate ownership challenge
      description: Validates ownership challenge of the destination.
      operationId: logpush-jobs-validate-ownership-challenge
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - destination_conf
              - ownership_challenge
              properties:
                destination_conf:
                  $ref: '#/components/schemas/destination_conf'
                ownership_challenge:
                  $ref: '#/components/schemas/ownership_challenge'
      responses:
        4xx:
          description: Validate ownership challenge response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/validate_ownership_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Validate ownership challenge response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validate_ownership_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/logpush/validate/destination/exists:
    post:
      tags:
      - Logpush Jobs
      summary: Check destination exists
      description: Checks if there is an existing job with a destination.
      operationId: logpush-jobs-check-destination-exists
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - destination_conf
              properties:
                destination_conf:
                  $ref: '#/components/schemas/destination_conf'
      responses:
        4xx:
          description: Check destination exists response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/destination_exists_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Check destination exists response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/destination_exists_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/logpush/validate/origin:
    post:
      tags:
      - Logpush Jobs
      summary: Validate origin
      description: Validates logpull origin with logpull_options.
      operationId: logpush-jobs-validate-origin
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - logpull_options
              properties:
                logpull_options:
                  $ref: '#/components/schemas/logpull_options'
      responses:
        4xx:
          description: Validate origin response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/validate_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Validate origin response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/validate_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/logs/control/retention/flag:
    get:
      tags:
      - Logs Received
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get log retention flag response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/flag_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get log retention flag response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/flag_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Logs Received
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - flag
              properties:
                flag:
                  $ref: '#/components/schemas/flag'
      responses:
        4xx:
          description: Update log retention flag response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/flag_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update log retention flag response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/flag_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/logs/rayids/{ray_identifier}:
    get:
      tags:
      - Logs Received
      summary: 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/ray_identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get logs RayIDs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logs'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get logs RayIDs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logs'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/logs/received:
    get:
      tags:
      - Logs Received
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get logs received response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/logs'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get logs received response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/logs'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/logs/received/fields:
    get:
      tags:
      - Logs Received
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List fields response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/fields_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List fields response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/fields_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/origin_tls_client_auth:
    get:
      tags:
      - Zone-Level Authenticated Origin Pulls
      summary: List Certificates
      operationId: zone-level-authenticated-origin-pulls-list-certificates
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Certificates response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-certificate_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Certificates response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-certificate_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Zone-Level Authenticated Origin Pulls
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - certificate
              - private_key
              properties:
                certificate:
                  $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-certificate'
                private_key:
                  $ref: '#/components/schemas/private_key'
      responses:
        4xx:
          description: Upload Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Upload Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/origin_tls_client_auth/{identifier}:
    delete:
      tags:
      - Zone-Level Authenticated Origin Pulls
      summary: Delete Certificate
      operationId: zone-level-authenticated-origin-pulls-delete-certificate
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Zone-Level Authenticated Origin Pulls
      summary: Get Certificate Details
      operationId: zone-level-authenticated-origin-pulls-get-certificate-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Certificate Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Certificate Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/origin_tls_client_auth/hostnames:
    put:
      tags:
      - Per-hostname Authenticated Origin Pull
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - config
              properties:
                config:
                  $ref: '#/components/schemas/config'
      responses:
        4xx:
          description: Enable or Disable a Hostname for Client Authentication response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/hostname_aop_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Enable or Disable a Hostname for Client Authentication response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hostname_aop_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/origin_tls_client_auth/hostnames/{hostname}:
    get:
      tags:
      - Per-hostname Authenticated Origin Pull
      summary: 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/schemas-hostname'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get the Hostname Status for Client Authentication response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/hostname_aop_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get the Hostname Status for Client Authentication response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hostname_aop_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/origin_tls_client_auth/hostnames/certificates:
    get:
      tags:
      - Per-hostname Authenticated Origin Pull
      summary: List Certificates
      operationId: per-hostname-authenticated-origin-pull-list-certificates
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Certificates response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Certificates response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Per-hostname Authenticated Origin Pull
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - certificate
              - private_key
              properties:
                certificate:
                  $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-certificate'
                private_key:
                  $ref: '#/components/schemas/schemas-private_key'
      responses:
        4xx:
          description: Upload a Hostname Client Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-certificate_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Upload a Hostname Client Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-certificate_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/origin_tls_client_auth/hostnames/certificates/{identifier}:
    delete:
      tags:
      - Per-hostname Authenticated Origin Pull
      summary: Delete Hostname Client Certificate
      operationId: per-hostname-authenticated-origin-pull-delete-hostname-client-certificate
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Hostname Client Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-certificate_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Hostname Client Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-certificate_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Per-hostname Authenticated Origin Pull
      summary: 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: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/hostname-authenticated-origin-pull_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get the Hostname Client Certificate response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-certificate_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get the Hostname Client Certificate response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-certificate_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/origin_tls_client_auth/settings:
    get:
      tags:
      - Zone-Level Authenticated Origin Pulls
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Enablement Setting for Zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/enabled_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Enablement Setting for Zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enabled_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Zone-Level Authenticated Origin Pulls
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - enabled
              properties:
                enabled:
                  $ref: '#/components/schemas/zone-authenticated-origin-pull_components-schemas-enabled'
      responses:
        4xx:
          description: Set Enablement for Zone response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/enabled_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Set Enablement for Zone response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/enabled_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/pagerules:
    get:
      tags:
      - Page Rules
      summary: List Page Rules
      description: Fetches Page Rules in a zone.
      operationId: page-rules-list-page-rules
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Page Rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pagerule_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Page Rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pagerule_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Page Rules
      summary: Create a Page Rule
      description: Creates a new Page Rule.
      operationId: page-rules-create-a-page-rule
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - targets
              - actions
              properties:
                actions:
                  $ref: '#/components/schemas/schemas-actions'
                priority:
                  $ref: '#/components/schemas/page-rule_components-schemas-priority'
                status:
                  $ref: '#/components/schemas/page-rule_components-schemas-status'
                targets:
                  $ref: '#/components/schemas/targets'
      responses:
        4xx:
          description: Create a Page Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pagerule_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a Page Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pagerule_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/pagerules/{identifier}:
    delete:
      tags:
      - Page Rules
      summary: Delete a Page Rule
      description: Deletes an existing Page Rule.
      operationId: page-rules-delete-a-page-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a Page Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a Page Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Page Rules
      summary: Get a Page Rule
      description: Fetches the details of a Page Rule.
      operationId: page-rules-get-a-page-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a Page Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pagerule_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a Page Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pagerule_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Page Rules
      summary: Edit a Page Rule
      description: Updates one or more fields of an existing Page Rule.
      operationId: page-rules-edit-a-page-rule
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                actions:
                  $ref: '#/components/schemas/schemas-actions'
                priority:
                  $ref: '#/components/schemas/page-rule_components-schemas-priority'
                status:
                  $ref: '#/components/schemas/page-rule_components-schemas-status'
                targets:
                  $ref: '#/components/schemas/targets'
      responses:
        4xx:
          description: Edit a Page Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pagerule_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit a Page Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pagerule_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Page Rules
      summary: 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: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - targets
              - actions
              properties:
                actions:
                  $ref: '#/components/schemas/schemas-actions'
                priority:
                  $ref: '#/components/schemas/page-rule_components-schemas-priority'
                status:
                  $ref: '#/components/schemas/page-rule_components-schemas-status'
                targets:
                  $ref: '#/components/schemas/targets'
      responses:
        4xx:
          description: Update a Page Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pagerule_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a Page Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pagerule_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/pagerules/settings:
    get:
      tags:
      - Available Page Rules settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List available Page Rules settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/pagerule_settings_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List available Page Rules settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/pagerule_settings_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/railguns:
    get:
      tags:
      - Railgun Connections for a Zone
      summary: List available Railguns
      description: A list of available Railguns the zone can use.
      operationId: railgun-connections-for-a-zone-list-available-railguns
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List available Railguns response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-railgun_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List available Railguns response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-railgun_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/railguns/{identifier}:
    get:
      tags:
      - Railgun Connections for a Zone
      summary: Railgun details
      description: Lists details about a specific Railgun.
      operationId: railgun-connections-for-a-zone-railgun-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier-2'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Railgun details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Railgun details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Railgun Connections for a Zone
      summary: Connect or disconnect a Railgun
      description: Connect or disconnect a Railgun.
      operationId: railgun-connections-for-a-zone-connect-or-disconnect-a-railgun
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier-2'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - connected
              properties:
                connected:
                  $ref: '#/components/schemas/connected'
      responses:
        4xx:
          description: Connect or disconnect a Railgun response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/railgun_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Connect or disconnect a Railgun response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/railgun_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/railguns/{identifier}/diagnose:
    get:
      tags:
      - Railgun Connections for a Zone
      summary: Test Railgun connection
      description: Tests the Railgun connection to the zone.
      operationId: railgun-connections-for-a-zone-test-railgun-connection
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/railgun_components-schemas-identifier-2'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Test Railgun connection response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/test_connection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Test Railgun connection response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/test_connection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/rate_limits:
    get:
      tags:
      - Rate limits for a zone
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List rate limits response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ratelimit_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List rate limits response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ratelimit_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Rate limits for a zone
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - match
              - threshold
              - period
              - action
      responses:
        4xx:
          description: Create a rate limit response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ratelimit_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a rate limit response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ratelimit_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/rate_limits/{id}:
    delete:
      tags:
      - Rate limits for a zone
      summary: 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/rate-limits_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete a rate limit response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/ratelimit_response_single'
                  - type: object
                    properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/rate-limits_components-schemas-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete a rate limit response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ratelimit_response_single'
                - type: object
                  properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/rate-limits_components-schemas-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Rate limits for a zone
      summary: 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/rate-limits_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get a rate limit response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ratelimit_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get a rate limit response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ratelimit_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Rate limits for a zone
      summary: 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/rate-limits_components-schemas-id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - id
              - match
              - threshold
              - period
              - action
      responses:
        4xx:
          description: Update a rate limit response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ratelimit_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update a rate limit response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ratelimit_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get all Zone settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get all Zone settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zone_settings_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Edit zone settings info
      description: Edit settings for a zone.
      operationId: zone-settings-edit-zone-settings-info
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-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/setting'
      responses:
        4xx:
          description: Edit zone settings info response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit zone settings info response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/zone_settings_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/0rtt:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get 0-RTT session resumption setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/0rtt'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get 0-RTT session resumption setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/0rtt'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/0rtt_value'
      responses:
        4xx:
          description: Change 0-RTT session resumption setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/0rtt'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change 0-RTT session resumption setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/0rtt'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/advanced_ddos:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Advanced DDOS setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/advanced_ddos'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Advanced DDOS setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/advanced_ddos'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/always_online:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Always Online setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/always_online'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Always Online setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/always_online'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/always_online_value'
      responses:
        4xx:
          description: Change Always Online setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/always_online'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Always Online setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/always_online'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/always_use_https:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Always Use HTTPS setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/always_use_https'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Always Use HTTPS setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/always_use_https'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/always_use_https_value'
      responses:
        4xx:
          description: Change Always Use HTTPS setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/always_use_https'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Always Use HTTPS setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/always_use_https'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/automatic_https_rewrites:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Automatic HTTPS Rewrites setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/automatic_https_rewrites'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Automatic HTTPS Rewrites setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/automatic_https_rewrites'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/automatic_https_rewrites_value'
      responses:
        4xx:
          description: Change Automatic HTTPS Rewrites setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/automatic_https_rewrites'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Automatic HTTPS Rewrites setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/automatic_https_rewrites'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/automatic_platform_optimization:
    get:
      tags:
      - Zone Settings
      summary: Get Automatic Platform Optimization for WordPress settings
      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-for-word-press-settings
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Automatic Platform Optimization for WordPress settings
            response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/automatic_platform_optimization'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Automatic Platform Optimization for WordPress settings
            response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/automatic_platform_optimization'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change Automatic Platform Optimization for WordPress settings
      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-for-word-press-settings
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/automatic_platform_optimization'
      responses:
        4xx:
          description: Change Automatic Platform Optimization for WordPress settings
            response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/automatic_platform_optimization'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Automatic Platform Optimization for WordPress settings
            response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/automatic_platform_optimization'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/brotli:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Brotli setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/brotli'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Brotli setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/brotli'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/brotli_value'
      responses:
        4xx:
          description: Change Brotli setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/brotli'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Brotli setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/brotli'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/browser_cache_ttl:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Browser Cache TTL setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/browser_cache_ttl'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Browser Cache TTL setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/browser_cache_ttl'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/browser_cache_ttl_value'
      responses:
        4xx:
          description: Change Browser Cache TTL setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/browser_cache_ttl'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Browser Cache TTL setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/browser_cache_ttl'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/browser_check:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Browser Check setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/browser_check'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Browser Check setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/browser_check'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/browser_check_value'
      responses:
        4xx:
          description: Change Browser Check setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/browser_check'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Browser Check setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/browser_check'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/cache_level:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Cache Level setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cache_level'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Cache Level setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/cache_level'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/cache_level_value'
      responses:
        4xx:
          description: Change Cache Level setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/cache_level'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Cache Level setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/cache_level'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/challenge_ttl:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Challenge TTL setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/challenge_ttl'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Challenge TTL setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/challenge_ttl'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/challenge_ttl_value'
      responses:
        4xx:
          description: Change Challenge TTL setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/challenge_ttl'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Challenge TTL setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/challenge_ttl'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/ciphers:
    get:
      tags:
      - Zone Settings
      summary: Get ciphers setting
      description: Gets ciphers setting.
      operationId: zone-settings-get-ciphers-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get ciphers setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/ciphers'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get ciphers setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/ciphers'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change ciphers setting
      description: Changes ciphers setting.
      operationId: zone-settings-change-ciphers-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/ciphers_value'
      responses:
        4xx:
          description: Change ciphers setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/ciphers'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change ciphers setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/ciphers'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/development_mode:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Development Mode setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/development_mode'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Development Mode setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/development_mode'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/development_mode_value'
      responses:
        4xx:
          description: Change Development Mode setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/development_mode'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Development Mode setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/development_mode'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/early_hints:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Early Hints setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/early_hints'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Early Hints setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/early_hints'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/early_hints_value'
      responses:
        4xx:
          description: Change Early Hints setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/early_hints'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Early Hints setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/early_hints'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/email_obfuscation:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Email Obfuscation setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/email_obfuscation'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Email Obfuscation setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/email_obfuscation'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/email_obfuscation_value'
      responses:
        4xx:
          description: Change Email Obfuscation setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/email_obfuscation'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Email Obfuscation setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/email_obfuscation'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/h2_prioritization:
    get:
      tags:
      - Zone Settings
      summary: Get HTTP/2 Edge Prioritization setting
      description: Gets HTTP/2 Edge Prioritization setting.
      operationId: zone-settings-get-http/-2-edge-prioritization-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get HTTP/2 Edge Prioritization setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/h2_prioritization'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get HTTP/2 Edge Prioritization setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/h2_prioritization'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change HTTP/2 Edge Prioritization setting
      description: Changes HTTP/2 Edge Prioritization setting.
      operationId: zone-settings-change-http/-2-edge-prioritization-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/h2_prioritization_value'
      responses:
        4xx:
          description: Change HTTP/2 Edge Prioritization setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/h2_prioritization'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change HTTP/2 Edge Prioritization setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/h2_prioritization'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/hotlink_protection:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Hotlink Protection setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/hotlink_protection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Hotlink Protection setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/hotlink_protection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/hotlink_protection_value'
      responses:
        4xx:
          description: Change Hotlink Protection setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/hotlink_protection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Hotlink Protection setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/hotlink_protection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/http2:
    get:
      tags:
      - Zone Settings
      summary: Get HTTP2 setting
      description: Value of the HTTP2 setting.
      operationId: zone-settings-get-h-t-t-p-2-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get HTTP2 setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/http2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get HTTP2 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/http2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change HTTP2 setting
      description: Value of the HTTP2 setting.
      operationId: zone-settings-change-h-t-t-p-2-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/http2_value'
      responses:
        4xx:
          description: Change HTTP2 setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/http2'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change HTTP2 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/http2'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/http3:
    get:
      tags:
      - Zone Settings
      summary: Get HTTP3 setting
      description: Value of the HTTP3 setting.
      operationId: zone-settings-get-h-t-t-p-3-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get HTTP3 setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/http3'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get HTTP3 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/http3'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change HTTP3 setting
      description: Value of the HTTP3 setting.
      operationId: zone-settings-change-h-t-t-p-3-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/http3_value'
      responses:
        4xx:
          description: Change HTTP3 setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/http3'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change HTTP3 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/http3'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/image_resizing:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Image Resizing setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/image_resizing'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Image Resizing setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/image_resizing'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/image_resizing_value'
      responses:
        4xx:
          description: Change Image Resizing setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/image_resizing'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Image Resizing setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/image_resizing'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/ip_geolocation:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get IP Geolocation setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/ip_geolocation'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get IP Geolocation setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/ip_geolocation'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/ip_geolocation_value'
      responses:
        4xx:
          description: Change IP Geolocation setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/ip_geolocation'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change IP Geolocation setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/ip_geolocation'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/ipv6:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get IPv6 setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/ipv6'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get IPv6 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/ipv6'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/ipv6_value'
      responses:
        4xx:
          description: Change IPv6 setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/ipv6'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change IPv6 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/ipv6'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/min_tls_version:
    get:
      tags:
      - Zone Settings
      summary: Get Minimum TLS Version setting
      description: Gets Minimum TLS Version setting.
      operationId: zone-settings-get-minimum-tls-version-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Minimum TLS Version setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/min_tls_version'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Minimum TLS Version setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/min_tls_version'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change Minimum TLS Version setting
      description: Changes Minimum TLS Version setting.
      operationId: zone-settings-change-minimum-tls-version-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/min_tls_version_value'
      responses:
        4xx:
          description: Change Minimum TLS Version setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/min_tls_version'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Minimum TLS Version setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/min_tls_version'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/minify:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Minify setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/minify'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Minify setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/minify'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/minify_value'
      responses:
        4xx:
          description: Change Minify setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/minify'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Minify setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/minify'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/mirage:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Mirage setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/mirage'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Mirage setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/mirage'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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-mirage-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/mirage_value'
      responses:
        4xx:
          description: Change Mirage setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/mirage'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Mirage setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/mirage'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/mobile_redirect:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Mobile Redirect setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/mobile_redirect'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Mobile Redirect setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/mobile_redirect'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/mobile_redirect_value'
      responses:
        4xx:
          description: Change Mobile Redirect setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/mobile_redirect'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Mobile Redirect setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/mobile_redirect'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/nel:
    get:
      tags:
      - Zone Settings
      summary: Get Network Error Logging setting
      description: 'Enable Network Error Logging reporting on your zone. (Beta) '
      operationId: zone-settings-get-network-error-logging-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Network Error Logging setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/nel'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Network Error Logging setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/nel'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change Network Error Logging setting
      description: 'Enable Network Error Logging reporting on your zone. (Beta) '
      operationId: zone-settings-change-network-error-logging-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/nel_value'
      responses:
        4xx:
          description: Change Network Error Logging setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/nel'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Network Error Logging setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/nel'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/opportunistic_encryption:
    get:
      tags:
      - Zone Settings
      summary: Get Opportunistic Encryption setting
      description: Gets Opportunistic Encryption setting.
      operationId: zone-settings-get-opportunistic-encryption-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Opportunistic Encryption setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/opportunistic_encryption'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Opportunistic Encryption setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/opportunistic_encryption'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change Opportunistic Encryption setting
      description: Changes Opportunistic Encryption setting.
      operationId: zone-settings-change-opportunistic-encryption-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/opportunistic_encryption_value'
      responses:
        4xx:
          description: Change Opportunistic Encryption setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/opportunistic_encryption'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Opportunistic Encryption setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/opportunistic_encryption'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/opportunistic_onion:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Opportunistic Onion setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/opportunistic_onion'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Opportunistic Onion setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/opportunistic_onion'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/opportunistic_onion_value'
      responses:
        4xx:
          description: Change Opportunistic Onion setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/opportunistic_onion'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Opportunistic Onion setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/opportunistic_onion'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/orange_to_orange:
    get:
      tags:
      - Zone Settings
      summary: Get Orange to Orange (O2O)
      description: Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other
        zones also on Cloudflare.
      operationId: zone-settings-get-orange-to-orange-(-o-2-o)
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Orange to Orange (O2O) response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/orange_to_orange'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Orange to Orange (O2O) response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/orange_to_orange'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change Orange to Orange (O2O)
      description: Orange to Orange (O2O) allows zones on Cloudflare to CNAME to other
        zones also on Cloudflare.
      operationId: zone-settings-change-orange-to-orange-(-o-2-o)
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/orange_to_orange_value'
      responses:
        4xx:
          description: Change Orange to Orange (O2O) response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/orange_to_orange'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Orange to Orange (O2O) response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/orange_to_orange'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/origin_error_page_pass_thru:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Enable Error Pages On setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/origin_error_page_pass_thru'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Enable Error Pages On setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/origin_error_page_pass_thru'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/origin_error_page_pass_thru_value'
      responses:
        4xx:
          description: Change Enable Error Pages On setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/origin_error_page_pass_thru'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Enable Error Pages On setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/origin_error_page_pass_thru'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/origin_max_http_version:
    get:
      tags:
      - Zone Settings
      summary: Get Origin Max HTTP version setting
      description: Value of the Origin Max HTTP version setting (Note that the default
        value for Enterprise is "1").
      operationId: zone-settings-get-origin-max-http-version-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Origin Max HTTP version setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - $ref: '#/components/schemas/origin_max_http_version_response_value'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Origin Max HTTP version setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - $ref: '#/components/schemas/origin_max_http_version_response_value'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change Origin Max HTTP version setting
      description: 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.).
      operationId: zone-settings-change-origin-max-http-version-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/origin_max_http_version_value'
      responses:
        4xx:
          description: Change Origin Max HTTP version setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - $ref: '#/components/schemas/origin_max_http_version_response_value'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Origin Max HTTP version setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - $ref: '#/components/schemas/origin_max_http_version_response_value'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/polish:
    get:
      tags:
      - Zone Settings
      summary: Get Polish setting
      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.'
      operationId: zone-settings-get-polish-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Polish setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/polish'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Polish setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/polish'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change Polish setting
      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.'
      operationId: zone-settings-change-polish-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/polish_value'
      responses:
        4xx:
          description: Change Polish setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/polish'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Polish setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/polish'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/prefetch_preload:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get prefetch preload setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/prefetch_preload'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get prefetch preload setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/prefetch_preload'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/prefetch_preload_value'
      responses:
        4xx:
          description: Change prefetch preload setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/prefetch_preload'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change prefetch preload setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/prefetch_preload'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/privacy_pass:
    get:
      tags:
      - Zone Settings
      summary: Get Privacy Pass setting
      description: Privacy Pass is a browser extension developed by the Privacy Pass
        Team to improve the browsing experience for your visitors. Enabling Privacy
        Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).
      operationId: zone-settings-get-privacy-pass-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Privacy Pass setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/privacy_pass'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Privacy Pass setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/privacy_pass'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change Privacy Pass setting
      description: Privacy Pass is a browser extension developed by the Privacy Pass
        Team to improve the browsing experience for your visitors. Enabling Privacy
        Pass will reduce the number of CAPTCHAs shown to your visitors. (https://support.cloudflare.com/hc/en-us/articles/115001992652-Privacy-Pass).
      operationId: zone-settings-change-privacy-pass-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/privacy_pass_value'
      responses:
        4xx:
          description: Change Privacy Pass setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/privacy_pass'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Privacy Pass setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/privacy_pass'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/proxy_read_timeout:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Proxy Read Timeout setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/proxy_read_timeout'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Proxy Read Timeout setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/proxy_read_timeout'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/proxy_read_timeout_value'
      responses:
        4xx:
          description: Change Proxy Read Timeout setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/proxy_read_timeout'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Proxy Read Timeout setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/proxy_read_timeout'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/pseudo_ipv4:
    get:
      tags:
      - Zone Settings
      summary: Get Pseudo IPv4 setting
      description: Value of the Pseudo IPv4 setting.
      operationId: zone-settings-get-pseudo-i-pv4-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Pseudo IPv4 setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/pseudo_ipv4'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Pseudo IPv4 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/pseudo_ipv4'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change Pseudo IPv4 setting
      description: Value of the Pseudo IPv4 setting.
      operationId: zone-settings-change-pseudo-i-pv4-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/pseudo_ipv4_value'
      responses:
        4xx:
          description: Change Pseudo IPv4 setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/pseudo_ipv4'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Pseudo IPv4 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/pseudo_ipv4'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/response_buffering:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Response Buffering setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/response_buffering'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Response Buffering setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/response_buffering'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/response_buffering_value'
      responses:
        4xx:
          description: Change Response Buffering setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/response_buffering'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Response Buffering setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/response_buffering'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/rocket_loader:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Rocket Loader setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/rocket_loader'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Rocket Loader setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/rocket_loader'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/rocket_loader_value'
      responses:
        4xx:
          description: Change Rocket Loader setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/rocket_loader'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Rocket Loader setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/rocket_loader'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/security_header:
    get:
      tags:
      - Zone Settings
      summary: Get Security Header (HSTS) setting
      description: Cloudflare security header for a zone.
      operationId: zone-settings-get-security-header-(-hsts)-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Security Header (HSTS) setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/security_header'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Security Header (HSTS) setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/security_header'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change Security Header (HSTS) setting
      description: Cloudflare security header for a zone.
      operationId: zone-settings-change-security-header-(-hsts)-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/security_header_value'
      responses:
        4xx:
          description: Change Security Header (HSTS) setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/security_header'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Security Header (HSTS) setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/security_header'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/security_level:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Security Level setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/security_level'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Security Level setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/security_level'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/security_level_value'
      responses:
        4xx:
          description: Change Security Level setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/security_level'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Security Level setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/security_level'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/server_side_exclude:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Server Side Exclude setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/server_side_exclude'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Server Side Exclude setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/server_side_exclude'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/server_side_exclude_value'
      responses:
        4xx:
          description: Change Server Side Exclude setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/server_side_exclude'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Server Side Exclude setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/server_side_exclude'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/sort_query_string_for_cache:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Enable Query String Sort setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/sort_query_string_for_cache'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Enable Query String Sort setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/sort_query_string_for_cache'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/sort_query_string_for_cache_value'
      responses:
        4xx:
          description: Change Enable Query String Sort setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/sort_query_string_for_cache'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Enable Query String Sort setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/sort_query_string_for_cache'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/ssl:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get SSL setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/ssl'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get SSL setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/ssl'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/ssl_value'
      responses:
        4xx:
          description: Change SSL setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/ssl'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change SSL setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/ssl'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/ssl_recommender:
    get:
      tags:
      - Zone Settings
      summary: Get SSL/TLS Recommender enrollment
      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/-tls-recommender-enrollment
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get SSL/TLS Recommender enrollment response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/ssl_recommender'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get SSL/TLS Recommender enrollment response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/ssl_recommender'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change SSL/TLS Recommender enrollment
      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/-tls-recommender-enrollment
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - enabled
              properties:
                enabled:
                  $ref: '#/components/schemas/ssl_recommender_enabled'
      responses:
        4xx:
          description: Change SSL/TLS Recommender enrollment response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/ssl_recommender'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change SSL/TLS Recommender enrollment response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/ssl_recommender'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/tls_1_3:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get TLS 1.3 setting enabled for a zone response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/tls_1_3'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get TLS 1.3 setting enabled for a zone response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/tls_1_3'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: Change TLS 1.3 setting
      description: Changes TLS 1.3 setting.
      operationId: zone-settings-change-tls-1.-3-setting
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/tls_1_3_value'
      responses:
        4xx:
          description: Change TLS 1.3 setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/tls_1_3'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change TLS 1.3 setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/tls_1_3'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/tls_client_auth:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get TLS Client Auth setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/tls_client_auth'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get TLS Client Auth setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/tls_client_auth'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/tls_client_auth_value'
      responses:
        4xx:
          description: Change TLS Client Auth setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/tls_client_auth'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change TLS Client Auth setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/tls_client_auth'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/true_client_ip_header:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get True Client IP setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/true_client_ip_header'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get True Client IP setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/true_client_ip_header'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/true_client_ip_header_value'
      responses:
        4xx:
          description: Change True Client IP setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/true_client_ip_header'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change True Client IP setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/true_client_ip_header'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/waf:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Web Application Firewall (WAF) setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/waf'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Web Application Firewall (WAF) setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/waf'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/waf_value'
      responses:
        4xx:
          description: Change Web Application Firewall (WAF) setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/waf'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change Web Application Firewall (WAF) setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/waf'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/webp:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get WebP setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/webp'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get WebP setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/webp'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/webp_value'
      responses:
        4xx:
          description: Change WebP setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/webp'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change WebP setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/webp'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/settings/websockets:
    get:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get WebSockets setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/websockets'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get WebSockets setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/websockets'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Zone Settings
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              required:
              - value
              properties:
                value:
                  $ref: '#/components/schemas/websockets_value'
      responses:
        4xx:
          description: Change WebSockets setting response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/zone_settings_response_single'
                  - properties:
                      result:
                        $ref: '#/components/schemas/websockets'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Change WebSockets setting response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/zone_settings_response_single'
                - properties:
                    result:
                      $ref: '#/components/schemas/websockets'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/ssl/certificate_packs:
    get:
      tags:
      - Certificate Packs
      summary: List Certificate Packs
      description: For a given zone, list all active certificate packs.
      operationId: certificate-packs-list-certificate-packs
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Certificate Packs response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_pack_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Certificate Packs response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_pack_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Certificate Packs
      summary: Order Certificate Pack
      description: For a given zone, order a certificate pack with a list of hostnames.
      operationId: certificate-packs-order-certificate-pack
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              properties:
                hosts:
                  $ref: '#/components/schemas/schemas-hosts'
      responses:
        4xx:
          description: Order Certificate Pack response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_pack_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Order Certificate Pack response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_pack_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/ssl/certificate_packs/{identifier}:
    delete:
      tags:
      - Certificate Packs
      summary: 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: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/certificate-packs_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Advanced Certificate Manager Certificate Pack response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/delete_advanced_certificate_pack_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Advanced Certificate Manager Certificate Pack response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/delete_advanced_certificate_pack_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Certificate Packs
      summary: Get Certificate Pack
      description: For a given zone, get a certificate pack.
      operationId: certificate-packs-get-certificate-pack
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/certificate-packs_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Certificate Pack response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_pack_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Certificate Pack response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_pack_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Certificate Packs
      summary: 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: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/certificate-packs_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Restart Validation for Advanced Certificate Manager Certificate
            Pack response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/advanced_certificate_pack_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Restart Validation for Advanced Certificate Manager Certificate
            Pack response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/advanced_certificate_pack_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/ssl/certificate_packs/order:
    post:
      tags:
      - Certificate Packs
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-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/certificate_authority'
                cloudflare_branding:
                  $ref: '#/components/schemas/cloudflare_branding'
                hosts:
                  $ref: '#/components/schemas/schemas-hosts'
                type:
                  $ref: '#/components/schemas/advanced_type'
                validation_method:
                  $ref: '#/components/schemas/validation_method'
                validity_days:
                  $ref: '#/components/schemas/validity_days'
      responses:
        4xx:
          description: Order Advanced Certificate Manager Certificate Pack response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/advanced_certificate_pack_response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Order Advanced Certificate Manager Certificate Pack response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/advanced_certificate_pack_response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/ssl/certificate_packs/quota:
    get:
      tags:
      - Certificate Packs
      summary: Get Certificate Pack Quotas
      description: For a given zone, list certificate pack quotas.
      operationId: certificate-packs-get-certificate-pack-quotas
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Certificate Pack Quotas response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/certificate_pack_quota_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Certificate Pack Quotas response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/certificate_pack_quota_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/ssl/recommendation:
    get:
      tags:
      - SSL/TLS Mode Recommendation
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: SSL/TLS Recommendation response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - properties:
                      result:
                        properties:
                          id:
                            $ref: '#/components/schemas/schemas-id'
                          modified_on:
                            $ref: '#/components/schemas/timestamp'
                          value:
                            $ref: '#/components/schemas/components-schemas-value'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: SSL/TLS Recommendation response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - properties:
                    result:
                      properties:
                        id:
                          $ref: '#/components/schemas/schemas-id'
                        modified_on:
                          $ref: '#/components/schemas/timestamp'
                        value:
                          $ref: '#/components/schemas/components-schemas-value'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/ssl/universal/settings:
    get:
      tags:
      - Universal SSL Settings for a Zone
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Universal SSL Settings Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ssl_universal_settings_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Universal SSL Settings Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssl_universal_settings_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Universal SSL Settings for a Zone
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/universal'
      responses:
        4xx:
          description: Edit Universal SSL Settings response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ssl_universal_settings_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit Universal SSL Settings response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssl_universal_settings_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/ssl/verification:
    get:
      tags:
      - SSL Verification
      summary: SSL Verification Details
      description: Get SSL Verification Info for a Zone.
      operationId: ssl-verification-ssl-verification-details
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: SSL Verification Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ssl_verification_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: SSL Verification Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssl_verification_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/ssl/verification/{cert_pack_uuid}:
    patch:
      tags:
      - SSL Verification
      summary: 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: cert_pack_uuid
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/cert_pack_uuid'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/components-schemas-validation_method'
      responses:
        4xx:
          description: Edit SSL Certificate Pack Validation Method response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/ssl_validation_method_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit SSL Certificate Pack Validation Method response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ssl_validation_method_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/waiting_rooms:
    get:
      tags:
      - Waiting Room
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List waiting rooms response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List waiting rooms response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Waiting Room
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_waitingroom'
      responses:
        4xx:
          description: Create waiting room response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create waiting room response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}:
    delete:
      tags:
      - Waiting Room
      summary: 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/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete waiting room response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waiting_room_id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete waiting room response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waiting_room_id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Waiting Room
      summary: 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/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Waiting room details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Waiting room details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Waiting Room
      summary: 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/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_waitingroom'
      responses:
        4xx:
          description: Patch waiting room response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch waiting room response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Waiting Room
      summary: 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/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_waitingroom'
      responses:
        4xx:
          description: Update waiting room response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/waitingroom_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update waiting room response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/waitingroom_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events:
    get:
      tags:
      - Waiting Room
      summary: 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/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List events response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/event_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List events response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Waiting Room
      summary: 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/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_event'
      responses:
        4xx:
          description: Create event response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/event_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create event response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}:
    delete:
      tags:
      - Waiting Room
      summary: 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/event_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete event response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/event_id_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete event response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event_id_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Waiting Room
      summary: 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/event_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Event details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/event_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Event details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Waiting Room
      summary: 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/event_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_event'
      responses:
        4xx:
          description: Patch event response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/event_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch event response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Waiting Room
      summary: 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/event_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_event'
      responses:
        4xx:
          description: Update event response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/event_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update event response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/events/{event_id}/details:
    get:
      tags:
      - Waiting Room
      summary: 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/event_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Preview active event details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/event_details_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Preview active event details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/event_details_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules:
    get:
      tags:
      - Waiting Room
      summary: 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/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Waiting Room Rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-rules_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Waiting Room Rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-rules_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Waiting Room
      summary: 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/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_rule'
      responses:
        4xx:
          description: Create Waiting Room Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-rules_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Waiting Room Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-rules_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Waiting Room
      summary: 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/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/update_rules'
      responses:
        4xx:
          description: Replace Waiting Room Rules response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-rules_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Replace Waiting Room Rules response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-rules_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/rules/{rule_id}:
    delete:
      tags:
      - Waiting Room
      summary: 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/rule_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Waiting Room Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-rules_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Waiting Room Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-rules_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Waiting Room
      summary: 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/rule_id'
      - name: waiting_room_id
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/patch_rule'
      responses:
        4xx:
          description: Patch Waiting Room Rule response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-rules_response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Patch Waiting Room Rule response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-rules_response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/waiting_rooms/{waiting_room_id}/status:
    get:
      tags:
      - Waiting Room
      summary: 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/waiting_room_id'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get waiting room status response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/status_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get waiting room status response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/status_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/waiting_rooms/preview:
    post:
      tags:
      - Waiting Room
      summary: 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/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/query_preview'
      responses:
        4xx:
          description: Create a custom waiting room page preview response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-preview_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create a custom waiting room page preview response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-preview_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/web3/hostnames:
    get:
      tags:
      - Web3 Hostname
      summary: List Web3 Hostnames
      operationId: web3-hostname-list-web3-hostnames
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Web3 Hostnames response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/components-schemas-collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Web3 Hostnames response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/components-schemas-collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Web3 Hostname
      summary: Create Web3 Hostname
      operationId: web3-hostname-create-web3-hostname
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/create_request'
      responses:
        4xx:
          description: Create Web3 Hostname response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/web3-hostname_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Web3 Hostname response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/web3-hostname_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/web3/hostnames/{identifier}:
    delete:
      tags:
      - Web3 Hostname
      summary: Delete Web3 Hostname
      operationId: web3-hostname-delete-web3-hostname
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Web3 Hostname response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Web3 Hostname response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Web3 Hostname
      summary: Web3 Hostname Details
      operationId: web3-hostname-web3-hostname-details
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Web3 Hostname Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/web3-hostname_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Web3 Hostname Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/web3-hostname_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    patch:
      tags:
      - Web3 Hostname
      summary: Edit Web3 Hostname
      operationId: web3-hostname-edit-web3-hostname
      parameters:
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/modify_request'
      responses:
        4xx:
          description: Edit Web3 Hostname response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/web3-hostname_components-schemas-single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit Web3 Hostname response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/web3-hostname_components-schemas-single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list:
    get:
      tags:
      - Web3 Hostname
      summary: 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/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: IPFS Universal Path Gateway Content List Details response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/content_list_details_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: IPFS Universal Path Gateway Content List Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/content_list_details_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Web3 Hostname
      summary: 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/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/content_list_update_request'
      responses:
        4xx:
          description: Update IPFS Universal Path Gateway Content List response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/content_list_details_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update IPFS Universal Path Gateway Content List response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/content_list_details_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries:
    get:
      tags:
      - Web3 Hostname
      summary: 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/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List IPFS Universal Path Gateway Content List Entries response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/content_list_entry_collection_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List IPFS Universal Path Gateway Content List Entries response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/content_list_entry_collection_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Web3 Hostname
      summary: 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/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/content_list_entry_create_request'
      responses:
        4xx:
          description: Create IPFS Universal Path Gateway Content List Entry response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/content_list_entry_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create IPFS Universal Path Gateway Content List Entry response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/content_list_entry_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/web3/hostnames/{identifier}/ipfs_universal_path/content_list/entries/{content_list_entry_identifier}:
    delete:
      tags:
      - Web3 Hostname
      summary: 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/common_components-schemas-identifier'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete IPFS Universal Path Gateway Content List Entry response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single-id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete IPFS Universal Path Gateway Content List Entry response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single-id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Web3 Hostname
      summary: 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/common_components-schemas-identifier'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: IPFS Universal Path Gateway Content List Entry Details response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/content_list_entry_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: IPFS Universal Path Gateway Content List Entry Details response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/content_list_entry_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Web3 Hostname
      summary: 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/common_components-schemas-identifier'
      - name: identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/content_list_entry_create_request'
      responses:
        4xx:
          description: Edit IPFS Universal Path Gateway Content List Entry response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/content_list_entry_single_response'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Edit IPFS Universal Path Gateway Content List Entry response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/content_list_entry_single_response'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/workers/script:
    delete:
      tags:
      - Worker Script (Deprecated)
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Worker response failure
          content:
            application/json: {}
        "200":
          description: Delete Worker response
          content:
            application/json: {}
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Worker Script (Deprecated)
      summary: 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_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Download Worker response failure
          content:
            undefined:
              schema:
                example: addEventListener('fetch', event => { event.respondWith(fetch(event.request))
                  })
        "200":
          description: Download Worker response
          content:
            undefined:
              schema:
                example: addEventListener('fetch', event => { event.respondWith(fetch(event.request))
                  })
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Worker Script (Deprecated)
      summary: Upload Worker
      description: Upload a worker, or a new version of a worker.
      operationId: worker-script-(-deprecated)-upload-worker
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/javascript:
            schema:
              example: addEventListener('fetch', event => { event.respondWith(fetch(event.request))
                })
      responses:
        4xx:
          description: Upload Worker response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/script-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Upload Worker response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/script-response-single'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone_identifier}/workers/script/bindings:
    get:
      tags:
      - Worker Binding (Deprecated)
      summary: List Bindings
      description: List the bindings for a Workers script.
      operationId: worker-binding-(-deprecated)-list-bindings
      parameters:
      - name: zone_identifier
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Bindings response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-common'
                  - type: object
                    properties:
                      result:
                        type: array
                        items:
                          $ref: '#/components/schemas/binding'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Bindings response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-common'
                - type: object
                  properties:
                    result:
                      type: array
                      items:
                        $ref: '#/components/schemas/binding'
      deprecated: true
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone}/spectrum/analytics/aggregate/current:
    get:
      tags:
      - Spectrum Aggregate Analytics
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get current aggregated analytics response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/analytics-aggregate_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get current aggregated analytics response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/analytics-aggregate_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone}/spectrum/analytics/events/bytime:
    get:
      tags:
      - Spectrum Analytics (By Time)
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get analytics by time response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get analytics by time response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone}/spectrum/analytics/events/summary:
    get:
      tags:
      - Spectrum Analytics (Summary)
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get analytics summary response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get analytics summary response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/api-response-single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone}/spectrum/apps:
    get:
      tags:
      - Spectrum Applications
      summary: 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/common_components-schemas-identifier'
      responses:
        4xx:
          description: List Spectrum applications response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/app_components-schemas-response_collection'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: List Spectrum applications response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/app_components-schemas-response_collection'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    post:
      tags:
      - Spectrum Applications
      summary: 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/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/argo_smart_routing'
                dns:
                  $ref: '#/components/schemas/dns'
                edge_ips:
                  $ref: '#/components/schemas/edge_ips'
                ip_firewall:
                  $ref: '#/components/schemas/ip_firewall'
                origin_dns:
                  $ref: '#/components/schemas/origin_dns'
                origin_port:
                  $ref: '#/components/schemas/origin_port'
                protocol:
                  $ref: '#/components/schemas/protocol'
                proxy_protocol:
                  $ref: '#/components/schemas/proxy_protocol'
                tls:
                  $ref: '#/components/schemas/tls'
                traffic_type:
                  $ref: '#/components/schemas/traffic_type'
      responses:
        4xx:
          description: Create Spectrum application using a name for the origin response
            failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single_origin_dns'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Create Spectrum application using a name for the origin response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single_origin_dns'
      security:
      - api_email: []
        api_key: []
      - api_token: []
  /zones/{zone}/spectrum/apps/{app_id}:
    delete:
      tags:
      - Spectrum Applications
      summary: 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/app_id'
      - name: zone
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      requestBody:
        required: true
        content:
          application/json: {}
      responses:
        4xx:
          description: Delete Spectrum application response failure
          content:
            application/json:
              schema:
                allOf:
                - allOf:
                  - $ref: '#/components/schemas/api-response-single'
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          id:
                            $ref: '#/components/schemas/app_id'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Delete Spectrum application response
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/api-response-single'
                - type: object
                  properties:
                    result:
                      type: object
                      properties:
                        id:
                          $ref: '#/components/schemas/app_id'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    get:
      tags:
      - Spectrum Applications
      summary: 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/app_id'
      - name: zone
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/common_components-schemas-identifier'
      responses:
        4xx:
          description: Get Spectrum application configuration response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/schemas-response_single'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Get Spectrum application configuration response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/schemas-response_single'
      security:
      - api_email: []
        api_key: []
      - api_token: []
    put:
      tags:
      - Spectrum Applications
      summary: 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/app_id'
      - name: zone
        in: path
        required: true
        schema:
          $ref: '#/components/schemas/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/argo_smart_routing'
                dns:
                  $ref: '#/components/schemas/dns'
                edge_ips:
                  $ref: '#/components/schemas/edge_ips'
                ip_firewall:
                  $ref: '#/components/schemas/ip_firewall'
                origin_dns:
                  $ref: '#/components/schemas/origin_dns'
                origin_port:
                  $ref: '#/components/schemas/origin_port'
                protocol:
                  $ref: '#/components/schemas/protocol'
                proxy_protocol:
                  $ref: '#/components/schemas/proxy_protocol'
                tls:
                  $ref: '#/components/schemas/tls'
                traffic_type:
                  $ref: '#/components/schemas/traffic_type'
      responses:
        4xx:
          description: Update Spectrum application configuration using a name for
            the origin response failure
          content:
            application/json:
              schema:
                allOf:
                - $ref: '#/components/schemas/response_single_origin_dns'
                - $ref: '#/components/schemas/api-response-common-failure'
        "200":
          description: Update Spectrum application configuration using a name for
            the origin response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/response_single_origin_dns'
      security:
      - api_email: []
        api_key: []
      - api_token: []
servers:
- url: https://api.cloudflare.com/client/v4
  description: Client API